An OAuth 2.0 access token, sent as Authorization: Bearer <token>. MessageDesk is the OAuth 2.0 provider (backed by AWS Cognito): an integration such as Zapier obtains the token through the authorization-code flow when a user connects their MessageDesk account. Access tokens are valid for 24 hours and are refreshed with the refresh token.
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"MessageDesk Support Docs","colors":{"primary":"#6142b0","light":"#46405c","dark":"#927bce"},"logo":{"light":"https://mintcdn.com/messagedesk/QhGIkgKUhtWPITRC/logo/logo-light.png?fit=max\u0026auto=format\u0026n=QhGIkgKUhtWPITRC\u0026q=85\u0026s=81b390d644bcaf1fac3e4d4e865da834","dark":"https://mintcdn.com/messagedesk/QhGIkgKUhtWPITRC/logo/logo-dark.png?fit=max\u0026auto=format\u0026n=QhGIkgKUhtWPITRC\u0026q=85\u0026s=0936cf3d801ce769b5cf6bab48df7cb7"},"favicon":"https://cdn.prod.website-files.com/6349fd438ecb3a3594605225/63f40dc976ad75f583bb618e_md-favicon-32x32.png","navbar":{"links":[{"href":"https://www.messagedesk.com","label":"MessageDesk.com"},{"href":"https://inbox.messagedesk.com","label":"Log In"}],"primary":{"type":"button","label":"Start free trial","href":"https://www.messagedesk.com/get-started"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/messagedesk"}},"seo":{"metatags":{"canonical":"https://docs.messagedesk.com","robots":"index, follow"}},"integrations":{"segment":{"key":"V42HI89SHLXv1eBnt6NPpZQ59ExIhiMu"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","grok","aistudio","assistant"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Status","icon":"clock","href":"https://status.messagedesk.com/"},{"anchor":"Changelog","icon":"timer","href":"https://app.getbeamer.com/messagedesk/"},{"anchor":"Free Tools","icon":"wrench","href":"https://www.messagedesk.com/free-tools"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"messagedesk","hasAudioNarration":false,"actualSubdomain":"messagedesk","customDomains":["docs.messagedesk.com"],"gitSource":{"type":"github","owner":"alderwood-labs","repo":"docs","deployBranch":"main","contentDirectory":"docs-main","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae660ffdcaa81eff1cabf79","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"Guides","count":72},{"language":"default","tag":"Developer","count":27},{"language":"default","tag":"Settings","count":17},{"language":"default","tag":"Getting Started","count":16},{"language":"default","tag":"Workspace Settings","count":13},{"language":"default","tag":"Actions","count":10},{"language":"default","tag":"Additional resources","count":8},{"language":"default","tag":"Triggers","count":8},{"language":"default","tag":"Messaging","count":8},{"language":"default","tag":"Inbox","count":7}]},"assistantConfig":{"enableStarterQuestions":true,"deflection":{"enabled":true,"email":"support@messagedesk.com"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".sidebar-group-header~* button[aria-label^=\"Toggle\"][aria-expanded]{width:100%;display:flex;align-items:center;gap:0.75rem}.sidebar-group-header~* button[aria-label^=\"Toggle\"][aria-expanded]>svg:first-child{order:99!important;margin-left:auto!important;margin-right:0!important}.sidebar-group-header~* button[aria-label^=\"Toggle\"][aria-expanded]>.flex-1{min-width:0}.sidebar-group-header~* button[aria-label^=\"Toggle\"][aria-expanded]>svg:nth-child(2){order:0!important}"}],"page":{"pagePath":"developer/api-reference/endpoints/list-outbound-channels","slug":"/developer/api-reference/endpoints/list-outbound-channels","pageMetadata":{"title":"List outbound channels","openapi":"developer/api-reference/openapi.json GET /integrations/developer/zapier/outbound-channels","description":"Returns the phone numbers (outbound channels) the authenticated user may send from in the workspace.","href":"/developer/api-reference/endpoints/list-outbound-channels"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns the phone numbers (outbound channels) the authenticated user may send from in the workspace.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List outbound channels","openapi":"developer/api-reference/openapi.json GET /integrations/developer/zapier/outbound-channels","description":"Returns the phone numbers (outbound channels) the authenticated user may send from in the workspace.","href":"/developer/api-reference/endpoints/list-outbound-channels"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/messagedesk/f65d66f45b71928e/identify.js"],"openApiReferenceData":{"operation":{"description":"Returns the phone numbers (outbound channels) the authenticated user may send from in the workspace.","operationId":"listOutboundChannels","parameters":["2b99b763-4fec-4a52-90b0-e5b10a776e05"],"responses":{"200":"3532a3ac-be57-4da1-9e57-3883196d4cfb","401":"2b267ef9-117a-426a-8820-bb0505bdb2f0","403":"78666f0b-eac7-459e-8d15-f6fd6b9a0030","404":"e4237fa9-ffa0-45bb-b875-1c6a9737f290","500":"bb565f55-ff5e-4922-8bda-0d497532c6a1"},"security":["e670cbcd-1aaa-4e4d-8dca-9e9d8661226d"],"summary":"List outbound channels","tags":["Context lookups"],"method":"get","type":"path","servers":["12b75418-4d7b-4431-88cb-59f1067641fe"],"path":"/integrations/developer/zapier/outbound-channels","baseUrlOptions":["https://c3uezq47el.execute-api.us-west-2.amazonaws.com/main"],"title":"List outbound channels","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2b99b763-4fec-4a52-90b0-e5b10a776e05":{"description":"Workspace ID","in":"query","name":"workspaceId","required":true,"schema":{"type":"string","isRequired":true,"description":"Workspace ID","uniqueKey":"","typeLabel":"string"}}},"responses":{"3532a3ac-be57-4da1-9e57-3883196d4cfb":{"content":{"application/json":{"schema":{"items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string","uniqueKey":"items.[INDEX].address","typeLabel":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)","uniqueKey":"items.[INDEX].communicationType","typeLabel":"enum\u003cstring>"},"createdAt":{"description":"The date and time the record was created","type":"string","uniqueKey":"items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The date and time the record was soft deleted","uniqueKey":"items.[INDEX].deletedAt","typeLabel":"object"},"description":{"description":"An optional description of the communication channel","type":"string","uniqueKey":"items.[INDEX].description","typeLabel":"string"},"id":{"description":"The ULID of the channel","type":"string","uniqueKey":"items.[INDEX].id","typeLabel":"string"},"name":{"description":"The optional name of the channel","type":"string","uniqueKey":"items.[INDEX].name","typeLabel":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer","uniqueKey":"items.[INDEX].newMessagesCount","typeLabel":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string","uniqueKey":"items.[INDEX].object","typeLabel":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string","uniqueKey":"items.[INDEX].smsNumber.callForwardingNumber","typeLabel":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string","uniqueKey":"items.[INDEX].smsNumber.campaignId","typeLabel":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted","uniqueKey":"items.[INDEX].smsNumber.deletedAt","typeLabel":"object"},"id":{"description":"ID is the primary key for the sms number","type":"string","uniqueKey":"items.[INDEX].smsNumber.id","typeLabel":"string"},"metaData":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.metaData.additionalProperties","typeLabel":"any"},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific","uniqueKey":"items.[INDEX].smsNumber.metaData","typeLabel":"object"},"number":{"description":"Number is the phone number of the sms number","type":"string","uniqueKey":"items.[INDEX].smsNumber.number","typeLabel":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string","uniqueKey":"items.[INDEX].smsNumber.object","typeLabel":"string"},"outboundChannel":{"oneOf":[{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"}],"uniqueKey":"items.[INDEX].smsNumber.outboundChannel","typeLabel":"any"},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string","uniqueKey":"items.[INDEX].smsNumber.outboundChannelId","typeLabel":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number","uniqueKey":"items.[INDEX].smsNumber.provider","typeLabel":"enum\u003cstring>"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc","uniqueKey":"items.[INDEX].smsNumber.status","typeLabel":"enum\u003cstring>"},"tenant":{"properties":{"companyAddress":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.companyAddress","typeLabel":"string"},"companyDescription":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.companyDescription","typeLabel":"string"},"companyEmail":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.companyEmail","typeLabel":"string"},"companyLogo":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.companyLogo","typeLabel":"string"},"companyName":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.companyName","typeLabel":"string"},"companyPhone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.companyPhone","typeLabel":"string"},"companyWebsite":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.companyWebsite","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.deletedAt","typeLabel":"object"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.id","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.object","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].deletedAt","typeLabel":"object"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].id","typeLabel":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].deletedAt","typeLabel":"object"},"expiredAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].expiredAt","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].id","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].object","typeLabel":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].updatedAt","typeLabel":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].userMembership","typeLabel":"any"},"userMembershipId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].userMembershipId","typeLabel":"string"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].invitations.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].invitations","typeLabel":"object[]"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].permissions","typeLabel":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].updatedAt","typeLabel":"string"},"user":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.avatarUrl","typeLabel":"string"},"cognitoId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.cognitoId","typeLabel":"string"},"company":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.company","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.deletedAt","typeLabel":"object"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.email","typeLabel":"string"},"emailVerified":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.emailVerified","typeLabel":"boolean"},"firstName":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.firstName","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.id","typeLabel":"string"},"lastInboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.author","typeLabel":"any"},"billable":{"description":"Indicates if the message is billable.","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.billable","typeLabel":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.conversationIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.conversationIds","typeLabel":"string[]"},"createdAt":{"description":"The time the broadcast was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.createdAt","typeLabel":"string"},"createdById":{"description":"The user that created the broadcast","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.createdById","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the broadcast was deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.deletedAt","typeLabel":"object"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.deliveredAt","typeLabel":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.excludeConversationIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.excludeConversationIds","typeLabel":"string[]"},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.excludeGroupIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.excludeGroupIds","typeLabel":"string[]"},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.groupIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.groupIds","typeLabel":"string[]"},"id":{"description":"The unique ulid of the broadcast","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.id","typeLabel":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.media.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.media","typeLabel":"string[]"},"name":{"description":"The name of the broadcast","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.name","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.object","typeLabel":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.scheduleId","typeLabel":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.startedAt","typeLabel":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.status","typeLabel":"enum\u003cstring>"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"The tenant the broadcast belongs to","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.tenantId","typeLabel":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.text","typeLabel":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.totalDelivered","typeLabel":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.totalFailed","typeLabel":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.totalOptedOut","typeLabel":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.totalSent","typeLabel":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.updatedAt","typeLabel":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.user","typeLabel":"any"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","description":"The workspace the broadcast belongs to","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast","typeLabel":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcastId","typeLabel":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.communicationType","typeLabel":"enum\u003cstring>"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.assignedUserIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.assignedUserIds","typeLabel":"string[]"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.communicationType","typeLabel":"enum\u003cstring>"},"createdAt":{"description":"The time the conversation was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the conversation was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.deletedAt","typeLabel":"object"},"id":{"description":"The unique ulid of the conversation","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.id","typeLabel":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannelAddresses","typeLabel":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].address","typeLabel":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].blockedAt","typeLabel":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].blockedBy","typeLabel":"any"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].blockedById","typeLabel":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].carrier","typeLabel":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].communicationType","typeLabel":"enum\u003cstring>"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].city","typeLabel":"string"},"country":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].country","typeLabel":"string"},"countryCode":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].countryCode","typeLabel":"string"},"defaultBilling":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].defaultBilling","typeLabel":"boolean"},"defaultShipping":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].defaultShipping","typeLabel":"boolean"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].id","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].object","typeLabel":"string"},"postalCode":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].postalCode","typeLabel":"string"},"postalCodeSuffix":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].postalCodeSuffix","typeLabel":"string"},"state":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].state","typeLabel":"string"},"street":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].street","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses","typeLabel":"object[]"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.avatarUrl","typeLabel":"string"},"company":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.company","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.deletedAt","typeLabel":"object"},"firstName":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.firstName","typeLabel":"string"},"flags":{"items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.flags.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.flags","typeLabel":"string[]"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.id","typeLabel":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.inboundChannels","typeLabel":"array"},"lastInboundMessage":{"oneOf":[{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.lastInboundMessage","typeLabel":"any"},"lastInboundMessageTime":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.lastInboundMessageTime","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.lastName","typeLabel":"string"},"lastOutboundMessage":{"oneOf":[{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.lastOutboundMessage","typeLabel":"any"},"lastOutboundMessageTime":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.lastOutboundMessageTime","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.object","typeLabel":"string"},"properties":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.properties.additionalProperties","typeLabel":"any"},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.properties","typeLabel":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.source","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace","typeLabel":"object"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact","typeLabel":"object"},"contactId":{"description":"The id of the contact","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contactId","typeLabel":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].conversations","typeLabel":"array"},"createdAt":{"description":"The date and time the inbound channel was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].deletedAt","typeLabel":"object"},"id":{"description":"The unique identifier for the inbound channel","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].id","typeLabel":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].isDefault","typeLabel":"boolean"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].object","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].updatedAt","typeLabel":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].verifiedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels","typeLabel":"object[]"},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.labels.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.labels","typeLabel":"string[]"},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.lastInboundMessage","typeLabel":"any"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.lastMessage","typeLabel":"any"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.lastMessageTime","typeLabel":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.lastOutboundMessage","typeLabel":"any"},"name":{"description":"The optional name of the conversation","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.name","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.object","typeLabel":"string"},"outboundChannel":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.outboundChannel","typeLabel":"any"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.outboundChannelId","typeLabel":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.status","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.tenantId","typeLabel":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation","typeLabel":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversationId","typeLabel":"string"},"createdAt":{"description":"The time the message was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the message was deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.deletedAt","typeLabel":"object"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.deliveredAt","typeLabel":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].createdAt","typeLabel":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].dataType","typeLabel":"enum\u003cstring>"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The deleted at timestamp","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].deletedAt","typeLabel":"object"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].displayName","typeLabel":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].fallback","typeLabel":"string"},"id":{"description":"The ulid for the tag","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].id","typeLabel":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].key","typeLabel":"string"},"object":{"description":"The object type of the tag","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].object","typeLabel":"string"},"template":{"description":"The templated text we search for in the message","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].template","typeLabel":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].updatedAt","typeLabel":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks","typeLabel":"object[]"},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.from","typeLabel":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.group.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.group","typeLabel":"string[]"},"id":{"description":"The unique identifier of the message","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.id","typeLabel":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.media.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.media","typeLabel":"string[]"},"multipartId":{"description":"The provider ID of the multipart message","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.multipartId","typeLabel":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.multipartNum","typeLabel":"integer"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.object","typeLabel":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.outbound","typeLabel":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.priority","typeLabel":"enum\u003cstring>"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.provider","typeLabel":"enum\u003cstring>"},"providerErr":{"description":"An error string returned by the provider","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.providerErr","typeLabel":"string"},"providerId":{"description":"The external provider message ID","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.providerId","typeLabel":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.providerRef","typeLabel":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.reactions.items.[INDEX].content","typeLabel":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.reactions.items.[INDEX].userIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.reactions.items.[INDEX].userIds","typeLabel":"string[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.reactions.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.reactions","typeLabel":"object[]"},"readAt":{"description":"When the message was read at by the recipient","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.readAt","typeLabel":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX].actionType","typeLabel":"enum\u003cstring>"},"data":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX].data.additionalProperties","typeLabel":"any"},"type":"object","description":"The data to pass to the action","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX].data","typeLabel":"object"},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX].id","typeLabel":"string"},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX].delay.delay","typeLabel":"integer"},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX].delay.unit","typeLabel":"enum\u003cstring>"}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX].delay","typeLabel":"object"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX].eventData.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX].eventData","typeLabel":"string[]"},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX].order","typeLabel":"integer"}},"required":["actionType","data","id"],"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions","typeLabel":"object[]"},"activeHours":{"properties":{"flipLogic":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.flipLogic","typeLabel":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.friday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.friday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.friday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.friday","typeLabel":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.monday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.monday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.monday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.monday","typeLabel":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.saturday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.saturday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.saturday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.saturday","typeLabel":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.sunday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.sunday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.sunday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.sunday","typeLabel":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.thursday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.thursday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.thursday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.thursday","typeLabel":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.timezone","typeLabel":"enum\u003cstring>"},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.tuesday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.tuesday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.tuesday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.tuesday","typeLabel":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.wednesday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.wednesday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.wednesday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.wednesday","typeLabel":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times.","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours","typeLabel":"object"},"color":{"description":"The color of the relay","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.color","typeLabel":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions.items.[INDEX].id","typeLabel":"string"},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions.items.[INDEX].logicalOperator","typeLabel":"enum\u003cstring>"},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions.items.[INDEX].useCase","typeLabel":"enum\u003cstring>"},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions.items.[INDEX].caseSensitive","typeLabel":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions.items.[INDEX].matchData.additionalProperties","typeLabel":"any"},"type":"object","description":"Additional match criteria for use cases that require structured data","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions.items.[INDEX].matchData","typeLabel":"object"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions.items.[INDEX].matchValue","typeLabel":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions.items.[INDEX].order","typeLabel":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions","typeLabel":"object[]"},"createdAt":{"description":"The time when the relay was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time when the relay was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.deletedAt","typeLabel":"object"},"description":{"description":"The custom description of the relay","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.description","typeLabel":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.eventName","typeLabel":"enum\u003cstring>"},"icon":{"description":"The icon of the relay","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.icon","typeLabel":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.id","typeLabel":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.lastTriggeredAt","typeLabel":"string"},"name":{"description":"The custom name of the relay","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.name","typeLabel":"string"},"object":{"description":"The object type of the relay","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.object","typeLabel":"string"},"order":{"description":"The order the relay is executed in","type":"integer","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.order","typeLabel":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.pausedAt","typeLabel":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.relayType","typeLabel":"enum\u003cstring>"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.stopOnSuccess","typeLabel":"boolean"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the relay belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.tenantId","typeLabel":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.updatedAt","typeLabel":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.userId","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay","typeLabel":"object"},"relayId":{"description":"The relay that sent the message","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relayId","typeLabel":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.segmentCount","typeLabel":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.smsType","typeLabel":"enum\u003cstring>"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.standardErr","typeLabel":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.status","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the message belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.tenantId","typeLabel":"string"},"text":{"description":"The message text","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.text","typeLabel":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].author","typeLabel":"any"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.assignedUserIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.assignedUserIds","typeLabel":"string[]"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.communicationType","typeLabel":"enum\u003cstring>"},"createdAt":{"description":"The time the conversation was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the conversation was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.deletedAt","typeLabel":"object"},"id":{"description":"The unique ulid of the conversation","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.id","typeLabel":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannelAddresses","typeLabel":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].address","typeLabel":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].blockedAt","typeLabel":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].blockedBy","typeLabel":"any"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].blockedById","typeLabel":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].carrier","typeLabel":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].communicationType","typeLabel":"enum\u003cstring>"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].city","typeLabel":"string"},"country":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].country","typeLabel":"string"},"countryCode":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].countryCode","typeLabel":"string"},"defaultBilling":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].defaultBilling","typeLabel":"boolean"},"defaultShipping":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].defaultShipping","typeLabel":"boolean"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].id","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].object","typeLabel":"string"},"postalCode":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].postalCode","typeLabel":"string"},"postalCodeSuffix":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].postalCodeSuffix","typeLabel":"string"},"state":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].state","typeLabel":"string"},"street":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].street","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses","typeLabel":"object[]"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.avatarUrl","typeLabel":"string"},"company":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.company","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.deletedAt","typeLabel":"object"},"firstName":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.firstName","typeLabel":"string"},"flags":{"items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.flags.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.flags","typeLabel":"string[]"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.id","typeLabel":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.inboundChannels","typeLabel":"array"},"lastInboundMessage":{"oneOf":[{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.lastInboundMessage","typeLabel":"any"},"lastInboundMessageTime":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.lastInboundMessageTime","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.lastName","typeLabel":"string"},"lastOutboundMessage":{"oneOf":[{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.lastOutboundMessage","typeLabel":"any"},"lastOutboundMessageTime":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.lastOutboundMessageTime","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.object","typeLabel":"string"},"properties":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.properties.additionalProperties","typeLabel":"any"},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.properties","typeLabel":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.source","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace","typeLabel":"object"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact","typeLabel":"object"},"contactId":{"description":"The id of the contact","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contactId","typeLabel":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].conversations","typeLabel":"array"},"createdAt":{"description":"The date and time the inbound channel was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].deletedAt","typeLabel":"object"},"id":{"description":"The unique identifier for the inbound channel","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].id","typeLabel":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].isDefault","typeLabel":"boolean"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].object","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].updatedAt","typeLabel":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].verifiedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels","typeLabel":"object[]"},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.labels.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.labels","typeLabel":"string[]"},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.lastInboundMessage","typeLabel":"any"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.lastMessage","typeLabel":"any"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.lastMessageTime","typeLabel":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.lastOutboundMessage","typeLabel":"any"},"name":{"description":"The optional name of the conversation","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.name","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.object","typeLabel":"string"},"outboundChannel":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.outboundChannel","typeLabel":"any"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.outboundChannelId","typeLabel":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.status","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.tenantId","typeLabel":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation","typeLabel":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversationId","typeLabel":"string"},"createdAt":{"description":"The time the message was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the message was deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].deletedAt","typeLabel":"object"},"id":{"description":"The unique identifier of the message","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].id","typeLabel":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].media.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].media","typeLabel":"string[]"},"mentions":{"items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].mentions.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].mentions","typeLabel":"string[]"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].object","typeLabel":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].reactions.items.[INDEX].content","typeLabel":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].reactions.items.[INDEX].userIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].reactions.items.[INDEX].userIds","typeLabel":"string[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].reactions.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].reactions","typeLabel":"object[]"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the message belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].tenantId","typeLabel":"string"},"text":{"description":"The message text","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].text","typeLabel":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].thread","typeLabel":"any"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].threadId","typeLabel":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].updatedAt","typeLabel":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].userId","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments","typeLabel":"object[]"},"createdAt":{"description":"The time the message was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the message was deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.deletedAt","typeLabel":"object"},"id":{"description":"The unique identifier of the message","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.id","typeLabel":"string"},"lastReplyText":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.lastReplyText","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.object","typeLabel":"string"},"parentId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.parentId","typeLabel":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.parentType","typeLabel":"enum\u003cstring>"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the message belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.tenantId","typeLabel":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspaceId","typeLabel":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread","typeLabel":"object"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.to","typeLabel":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.updatedAt","typeLabel":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.userId","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastInboundMessage","typeLabel":"object"},"lastName":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastName","typeLabel":"string"},"lastOutboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.author","typeLabel":"any"},"billable":{"description":"Indicates if the message is billable.","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.billable","typeLabel":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.conversationIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.conversationIds","typeLabel":"string[]"},"createdAt":{"description":"The time the broadcast was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.createdAt","typeLabel":"string"},"createdById":{"description":"The user that created the broadcast","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.createdById","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the broadcast was deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.deletedAt","typeLabel":"object"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.deliveredAt","typeLabel":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.excludeConversationIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.excludeConversationIds","typeLabel":"string[]"},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.excludeGroupIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.excludeGroupIds","typeLabel":"string[]"},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.groupIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.groupIds","typeLabel":"string[]"},"id":{"description":"The unique ulid of the broadcast","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.id","typeLabel":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.media.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.media","typeLabel":"string[]"},"name":{"description":"The name of the broadcast","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.name","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.object","typeLabel":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.scheduleId","typeLabel":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.startedAt","typeLabel":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.status","typeLabel":"enum\u003cstring>"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"The tenant the broadcast belongs to","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.tenantId","typeLabel":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.text","typeLabel":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.totalDelivered","typeLabel":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.totalFailed","typeLabel":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.totalOptedOut","typeLabel":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.totalSent","typeLabel":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.updatedAt","typeLabel":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.user","typeLabel":"any"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","description":"The workspace the broadcast belongs to","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast","typeLabel":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcastId","typeLabel":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.communicationType","typeLabel":"enum\u003cstring>"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.assignedUserIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.assignedUserIds","typeLabel":"string[]"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.communicationType","typeLabel":"enum\u003cstring>"},"createdAt":{"description":"The time the conversation was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the conversation was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.deletedAt","typeLabel":"object"},"id":{"description":"The unique ulid of the conversation","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.id","typeLabel":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannelAddresses","typeLabel":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].address","typeLabel":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].blockedAt","typeLabel":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].blockedBy","typeLabel":"any"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].blockedById","typeLabel":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].carrier","typeLabel":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].communicationType","typeLabel":"enum\u003cstring>"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].city","typeLabel":"string"},"country":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].country","typeLabel":"string"},"countryCode":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].countryCode","typeLabel":"string"},"defaultBilling":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].defaultBilling","typeLabel":"boolean"},"defaultShipping":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].defaultShipping","typeLabel":"boolean"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].id","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].object","typeLabel":"string"},"postalCode":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].postalCode","typeLabel":"string"},"postalCodeSuffix":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].postalCodeSuffix","typeLabel":"string"},"state":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].state","typeLabel":"string"},"street":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].street","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses","typeLabel":"object[]"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.avatarUrl","typeLabel":"string"},"company":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.company","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.deletedAt","typeLabel":"object"},"firstName":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.firstName","typeLabel":"string"},"flags":{"items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.flags.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.flags","typeLabel":"string[]"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.id","typeLabel":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.inboundChannels","typeLabel":"array"},"lastInboundMessage":{"oneOf":[{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.lastInboundMessage","typeLabel":"any"},"lastInboundMessageTime":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.lastInboundMessageTime","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.lastName","typeLabel":"string"},"lastOutboundMessage":{"oneOf":[{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.lastOutboundMessage","typeLabel":"any"},"lastOutboundMessageTime":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.lastOutboundMessageTime","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.object","typeLabel":"string"},"properties":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.properties.additionalProperties","typeLabel":"any"},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.properties","typeLabel":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.source","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace","typeLabel":"object"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact","typeLabel":"object"},"contactId":{"description":"The id of the contact","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contactId","typeLabel":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].conversations","typeLabel":"array"},"createdAt":{"description":"The date and time the inbound channel was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].deletedAt","typeLabel":"object"},"id":{"description":"The unique identifier for the inbound channel","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].id","typeLabel":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].isDefault","typeLabel":"boolean"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].object","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].updatedAt","typeLabel":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].verifiedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels","typeLabel":"object[]"},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.labels.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.labels","typeLabel":"string[]"},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.lastInboundMessage","typeLabel":"any"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.lastMessage","typeLabel":"any"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.lastMessageTime","typeLabel":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.lastOutboundMessage","typeLabel":"any"},"name":{"description":"The optional name of the conversation","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.name","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.object","typeLabel":"string"},"outboundChannel":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.outboundChannel","typeLabel":"any"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.outboundChannelId","typeLabel":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.status","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.tenantId","typeLabel":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation","typeLabel":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversationId","typeLabel":"string"},"createdAt":{"description":"The time the message was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the message was deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.deletedAt","typeLabel":"object"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.deliveredAt","typeLabel":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].createdAt","typeLabel":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].dataType","typeLabel":"enum\u003cstring>"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The deleted at timestamp","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].deletedAt","typeLabel":"object"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].displayName","typeLabel":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].fallback","typeLabel":"string"},"id":{"description":"The ulid for the tag","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].id","typeLabel":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].key","typeLabel":"string"},"object":{"description":"The object type of the tag","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].object","typeLabel":"string"},"template":{"description":"The templated text we search for in the message","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].template","typeLabel":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].updatedAt","typeLabel":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks","typeLabel":"object[]"},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.from","typeLabel":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.group.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.group","typeLabel":"string[]"},"id":{"description":"The unique identifier of the message","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.id","typeLabel":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.media.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.media","typeLabel":"string[]"},"multipartId":{"description":"The provider ID of the multipart message","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.multipartId","typeLabel":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.multipartNum","typeLabel":"integer"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.object","typeLabel":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.outbound","typeLabel":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.priority","typeLabel":"enum\u003cstring>"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.provider","typeLabel":"enum\u003cstring>"},"providerErr":{"description":"An error string returned by the provider","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.providerErr","typeLabel":"string"},"providerId":{"description":"The external provider message ID","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.providerId","typeLabel":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.providerRef","typeLabel":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.reactions.items.[INDEX].content","typeLabel":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.reactions.items.[INDEX].userIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.reactions.items.[INDEX].userIds","typeLabel":"string[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.reactions.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.reactions","typeLabel":"object[]"},"readAt":{"description":"When the message was read at by the recipient","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.readAt","typeLabel":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX].actionType","typeLabel":"enum\u003cstring>"},"data":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX].data.additionalProperties","typeLabel":"any"},"type":"object","description":"The data to pass to the action","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX].data","typeLabel":"object"},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX].id","typeLabel":"string"},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX].delay.delay","typeLabel":"integer"},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX].delay.unit","typeLabel":"enum\u003cstring>"}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX].delay","typeLabel":"object"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX].eventData.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX].eventData","typeLabel":"string[]"},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX].order","typeLabel":"integer"}},"required":["actionType","data","id"],"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions","typeLabel":"object[]"},"activeHours":{"properties":{"flipLogic":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.flipLogic","typeLabel":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.friday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.friday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.friday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.friday","typeLabel":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.monday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.monday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.monday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.monday","typeLabel":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.saturday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.saturday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.saturday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.saturday","typeLabel":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.sunday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.sunday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.sunday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.sunday","typeLabel":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.thursday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.thursday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.thursday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.thursday","typeLabel":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.timezone","typeLabel":"enum\u003cstring>"},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.tuesday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.tuesday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.tuesday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.tuesday","typeLabel":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.wednesday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.wednesday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.wednesday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.wednesday","typeLabel":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times.","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours","typeLabel":"object"},"color":{"description":"The color of the relay","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.color","typeLabel":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions.items.[INDEX].id","typeLabel":"string"},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions.items.[INDEX].logicalOperator","typeLabel":"enum\u003cstring>"},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions.items.[INDEX].useCase","typeLabel":"enum\u003cstring>"},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions.items.[INDEX].caseSensitive","typeLabel":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions.items.[INDEX].matchData.additionalProperties","typeLabel":"any"},"type":"object","description":"Additional match criteria for use cases that require structured data","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions.items.[INDEX].matchData","typeLabel":"object"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions.items.[INDEX].matchValue","typeLabel":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions.items.[INDEX].order","typeLabel":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions","typeLabel":"object[]"},"createdAt":{"description":"The time when the relay was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time when the relay was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.deletedAt","typeLabel":"object"},"description":{"description":"The custom description of the relay","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.description","typeLabel":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.eventName","typeLabel":"enum\u003cstring>"},"icon":{"description":"The icon of the relay","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.icon","typeLabel":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.id","typeLabel":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.lastTriggeredAt","typeLabel":"string"},"name":{"description":"The custom name of the relay","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.name","typeLabel":"string"},"object":{"description":"The object type of the relay","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.object","typeLabel":"string"},"order":{"description":"The order the relay is executed in","type":"integer","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.order","typeLabel":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.pausedAt","typeLabel":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.relayType","typeLabel":"enum\u003cstring>"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.stopOnSuccess","typeLabel":"boolean"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the relay belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.tenantId","typeLabel":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.updatedAt","typeLabel":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.userId","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay","typeLabel":"object"},"relayId":{"description":"The relay that sent the message","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relayId","typeLabel":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.segmentCount","typeLabel":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.smsType","typeLabel":"enum\u003cstring>"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.standardErr","typeLabel":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.status","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the message belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.tenantId","typeLabel":"string"},"text":{"description":"The message text","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.text","typeLabel":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].author","typeLabel":"any"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.assignedUserIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.assignedUserIds","typeLabel":"string[]"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.communicationType","typeLabel":"enum\u003cstring>"},"createdAt":{"description":"The time the conversation was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the conversation was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.deletedAt","typeLabel":"object"},"id":{"description":"The unique ulid of the conversation","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.id","typeLabel":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannelAddresses","typeLabel":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].address","typeLabel":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].blockedAt","typeLabel":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].blockedBy","typeLabel":"any"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].blockedById","typeLabel":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].carrier","typeLabel":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].communicationType","typeLabel":"enum\u003cstring>"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].city","typeLabel":"string"},"country":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].country","typeLabel":"string"},"countryCode":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].countryCode","typeLabel":"string"},"defaultBilling":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].defaultBilling","typeLabel":"boolean"},"defaultShipping":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].defaultShipping","typeLabel":"boolean"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].id","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].object","typeLabel":"string"},"postalCode":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].postalCode","typeLabel":"string"},"postalCodeSuffix":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].postalCodeSuffix","typeLabel":"string"},"state":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].state","typeLabel":"string"},"street":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].street","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses","typeLabel":"object[]"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.avatarUrl","typeLabel":"string"},"company":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.company","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.deletedAt","typeLabel":"object"},"firstName":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.firstName","typeLabel":"string"},"flags":{"items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.flags.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.flags","typeLabel":"string[]"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.id","typeLabel":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.inboundChannels","typeLabel":"array"},"lastInboundMessage":{"oneOf":[{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.lastInboundMessage","typeLabel":"any"},"lastInboundMessageTime":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.lastInboundMessageTime","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.lastName","typeLabel":"string"},"lastOutboundMessage":{"oneOf":[{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.lastOutboundMessage","typeLabel":"any"},"lastOutboundMessageTime":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.lastOutboundMessageTime","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.object","typeLabel":"string"},"properties":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.properties.additionalProperties","typeLabel":"any"},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.properties","typeLabel":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.source","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace","typeLabel":"object"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact","typeLabel":"object"},"contactId":{"description":"The id of the contact","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contactId","typeLabel":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].conversations","typeLabel":"array"},"createdAt":{"description":"The date and time the inbound channel was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].deletedAt","typeLabel":"object"},"id":{"description":"The unique identifier for the inbound channel","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].id","typeLabel":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].isDefault","typeLabel":"boolean"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].object","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].updatedAt","typeLabel":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].verifiedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels","typeLabel":"object[]"},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.labels.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.labels","typeLabel":"string[]"},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.lastInboundMessage","typeLabel":"any"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.lastMessage","typeLabel":"any"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.lastMessageTime","typeLabel":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.lastOutboundMessage","typeLabel":"any"},"name":{"description":"The optional name of the conversation","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.name","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.object","typeLabel":"string"},"outboundChannel":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.outboundChannel","typeLabel":"any"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.outboundChannelId","typeLabel":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.status","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.tenantId","typeLabel":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation","typeLabel":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversationId","typeLabel":"string"},"createdAt":{"description":"The time the message was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the message was deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].deletedAt","typeLabel":"object"},"id":{"description":"The unique identifier of the message","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].id","typeLabel":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].media.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].media","typeLabel":"string[]"},"mentions":{"items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].mentions.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].mentions","typeLabel":"string[]"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].object","typeLabel":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].reactions.items.[INDEX].content","typeLabel":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].reactions.items.[INDEX].userIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].reactions.items.[INDEX].userIds","typeLabel":"string[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].reactions.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].reactions","typeLabel":"object[]"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the message belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].tenantId","typeLabel":"string"},"text":{"description":"The message text","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].text","typeLabel":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].thread","typeLabel":"any"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].threadId","typeLabel":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].updatedAt","typeLabel":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].userId","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments","typeLabel":"object[]"},"createdAt":{"description":"The time the message was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the message was deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.deletedAt","typeLabel":"object"},"id":{"description":"The unique identifier of the message","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.id","typeLabel":"string"},"lastReplyText":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.lastReplyText","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.object","typeLabel":"string"},"parentId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.parentId","typeLabel":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.parentType","typeLabel":"enum\u003cstring>"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the message belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.tenantId","typeLabel":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspaceId","typeLabel":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread","typeLabel":"object"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.to","typeLabel":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.updatedAt","typeLabel":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.userId","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.lastOutboundMessage","typeLabel":"object"},"notificationTokens":{"description":"Relationships","items":{"properties":{"createdAt":{"description":"The time the notification token was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.notificationTokens.items.[INDEX].createdAt","typeLabel":"string"},"id":{"description":"The unique identifier for the notification token","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.notificationTokens.items.[INDEX].id","typeLabel":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.notificationTokens.items.[INDEX].object","typeLabel":"enum\u003cstring>"},"token":{"description":"The actual token of the notification token","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.notificationTokens.items.[INDEX].token","typeLabel":"string"},"updatedAt":{"description":"The time the notification token was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.notificationTokens.items.[INDEX].updatedAt","typeLabel":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.notificationTokens.items.[INDEX].user","typeLabel":"any"},"userId":{"description":"The user id that this notification token belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.notificationTokens.items.[INDEX].userId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.notificationTokens.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.notificationTokens","typeLabel":"object[]"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.object","typeLabel":"string"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.phone","typeLabel":"string"},"phoneVerified":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.phoneVerified","typeLabel":"boolean"},"properties":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.properties.additionalProperties","typeLabel":"any"},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.properties","typeLabel":"object"},"ssoProviders":{"items":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.ssoProviders.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.ssoProviders","typeLabel":"string[]"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.userMemberships","typeLabel":"array"},"username":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user.username","typeLabel":"string"}},"type":"object","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].user","typeLabel":"object"},"userId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userId","typeLabel":"string"},"userRole":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRole","typeLabel":"object"},"userRoleId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userRoleId","typeLabel":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].id","typeLabel":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].object","typeLabel":"enum\u003cstring>"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].updatedAt","typeLabel":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].userId","typeLabel":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].userMembership","typeLabel":"any"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].userMembershipId","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].userSettings","typeLabel":"object[]"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspace","typeLabel":"object"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.userMemberships","typeLabel":"object[]"},"workspaces":{"items":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX].workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.tenant.workspaces","typeLabel":"object[]"}},"type":"object","description":"Relationships","uniqueKey":"items.[INDEX].smsNumber.tenant","typeLabel":"object"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string","uniqueKey":"items.[INDEX].smsNumber.tenantId","typeLabel":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.tollFree","typeLabel":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].smsNumber.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].smsNumber.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].smsNumber.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].smsNumber.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].smsNumber.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].smsNumber.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].smsNumber.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].smsNumber.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber.workspace","typeLabel":"object"},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string","uniqueKey":"items.[INDEX].smsNumber.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].smsNumber","typeLabel":"object"},"tenant":{"properties":{"companyAddress":{"type":"string","uniqueKey":"items.[INDEX].tenant.companyAddress","typeLabel":"string"},"companyDescription":{"type":"string","uniqueKey":"items.[INDEX].tenant.companyDescription","typeLabel":"string"},"companyEmail":{"type":"string","uniqueKey":"items.[INDEX].tenant.companyEmail","typeLabel":"string"},"companyLogo":{"type":"string","uniqueKey":"items.[INDEX].tenant.companyLogo","typeLabel":"string"},"companyName":{"type":"string","uniqueKey":"items.[INDEX].tenant.companyName","typeLabel":"string"},"companyPhone":{"type":"string","uniqueKey":"items.[INDEX].tenant.companyPhone","typeLabel":"string"},"companyWebsite":{"type":"string","uniqueKey":"items.[INDEX].tenant.companyWebsite","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.deletedAt","typeLabel":"object"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.id","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.object","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].deletedAt","typeLabel":"object"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].id","typeLabel":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].deletedAt","typeLabel":"object"},"expiredAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].expiredAt","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].id","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].object","typeLabel":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].updatedAt","typeLabel":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].userMembership","typeLabel":"any"},"userMembershipId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].userMembershipId","typeLabel":"string"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].invitations.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].invitations.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].invitations","typeLabel":"object[]"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].permissions","typeLabel":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].updatedAt","typeLabel":"string"},"user":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.avatarUrl","typeLabel":"string"},"cognitoId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.cognitoId","typeLabel":"string"},"company":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.company","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.deletedAt","typeLabel":"object"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.email","typeLabel":"string"},"emailVerified":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.emailVerified","typeLabel":"boolean"},"firstName":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.firstName","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.id","typeLabel":"string"},"lastInboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.author","typeLabel":"any"},"billable":{"description":"Indicates if the message is billable.","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.billable","typeLabel":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.conversationIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.conversationIds","typeLabel":"string[]"},"createdAt":{"description":"The time the broadcast was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.createdAt","typeLabel":"string"},"createdById":{"description":"The user that created the broadcast","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.createdById","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the broadcast was deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.deletedAt","typeLabel":"object"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.deliveredAt","typeLabel":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.excludeConversationIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.excludeConversationIds","typeLabel":"string[]"},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.excludeGroupIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.excludeGroupIds","typeLabel":"string[]"},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.groupIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.groupIds","typeLabel":"string[]"},"id":{"description":"The unique ulid of the broadcast","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.id","typeLabel":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.media.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.media","typeLabel":"string[]"},"name":{"description":"The name of the broadcast","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.name","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.object","typeLabel":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.scheduleId","typeLabel":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.startedAt","typeLabel":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.status","typeLabel":"enum\u003cstring>"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"The tenant the broadcast belongs to","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.tenantId","typeLabel":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.text","typeLabel":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.totalDelivered","typeLabel":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.totalFailed","typeLabel":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.totalOptedOut","typeLabel":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.totalSent","typeLabel":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.updatedAt","typeLabel":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.user","typeLabel":"any"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","description":"The workspace the broadcast belongs to","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcast","typeLabel":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.broadcastId","typeLabel":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.communicationType","typeLabel":"enum\u003cstring>"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.assignedUserIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.assignedUserIds","typeLabel":"string[]"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.communicationType","typeLabel":"enum\u003cstring>"},"createdAt":{"description":"The time the conversation was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the conversation was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.deletedAt","typeLabel":"object"},"id":{"description":"The unique ulid of the conversation","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.id","typeLabel":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannelAddresses","typeLabel":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].address","typeLabel":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].blockedAt","typeLabel":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].blockedBy","typeLabel":"any"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].blockedById","typeLabel":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].carrier","typeLabel":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].communicationType","typeLabel":"enum\u003cstring>"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].city","typeLabel":"string"},"country":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].country","typeLabel":"string"},"countryCode":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].countryCode","typeLabel":"string"},"defaultBilling":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].defaultBilling","typeLabel":"boolean"},"defaultShipping":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].defaultShipping","typeLabel":"boolean"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].id","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].object","typeLabel":"string"},"postalCode":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].postalCode","typeLabel":"string"},"postalCodeSuffix":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].postalCodeSuffix","typeLabel":"string"},"state":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].state","typeLabel":"string"},"street":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].street","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses","typeLabel":"object[]"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.avatarUrl","typeLabel":"string"},"company":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.company","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.deletedAt","typeLabel":"object"},"firstName":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.firstName","typeLabel":"string"},"flags":{"items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.flags.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.flags","typeLabel":"string[]"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.id","typeLabel":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.inboundChannels","typeLabel":"array"},"lastInboundMessage":{"oneOf":[{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.lastInboundMessage","typeLabel":"any"},"lastInboundMessageTime":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.lastInboundMessageTime","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.lastName","typeLabel":"string"},"lastOutboundMessage":{"oneOf":[{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.lastOutboundMessage","typeLabel":"any"},"lastOutboundMessageTime":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.lastOutboundMessageTime","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.object","typeLabel":"string"},"properties":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.properties.additionalProperties","typeLabel":"any"},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.properties","typeLabel":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.source","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace","typeLabel":"object"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contact","typeLabel":"object"},"contactId":{"description":"The id of the contact","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].contactId","typeLabel":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].conversations","typeLabel":"array"},"createdAt":{"description":"The date and time the inbound channel was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].deletedAt","typeLabel":"object"},"id":{"description":"The unique identifier for the inbound channel","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].id","typeLabel":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].isDefault","typeLabel":"boolean"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].object","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].updatedAt","typeLabel":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].verifiedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.inboundChannels","typeLabel":"object[]"},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.labels.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.labels","typeLabel":"string[]"},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.lastInboundMessage","typeLabel":"any"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.lastMessage","typeLabel":"any"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.lastMessageTime","typeLabel":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.lastOutboundMessage","typeLabel":"any"},"name":{"description":"The optional name of the conversation","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.name","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.object","typeLabel":"string"},"outboundChannel":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.outboundChannel","typeLabel":"any"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.outboundChannelId","typeLabel":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.status","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.tenantId","typeLabel":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversation","typeLabel":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.conversationId","typeLabel":"string"},"createdAt":{"description":"The time the message was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the message was deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.deletedAt","typeLabel":"object"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.deliveredAt","typeLabel":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].createdAt","typeLabel":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].dataType","typeLabel":"enum\u003cstring>"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The deleted at timestamp","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].deletedAt","typeLabel":"object"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].displayName","typeLabel":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].fallback","typeLabel":"string"},"id":{"description":"The ulid for the tag","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].id","typeLabel":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].key","typeLabel":"string"},"object":{"description":"The object type of the tag","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].object","typeLabel":"string"},"template":{"description":"The templated text we search for in the message","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].template","typeLabel":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].updatedAt","typeLabel":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.fallbacks","typeLabel":"object[]"},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.from","typeLabel":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.group.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.group","typeLabel":"string[]"},"id":{"description":"The unique identifier of the message","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.id","typeLabel":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.media.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.media","typeLabel":"string[]"},"multipartId":{"description":"The provider ID of the multipart message","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.multipartId","typeLabel":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.multipartNum","typeLabel":"integer"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.object","typeLabel":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.outbound","typeLabel":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.priority","typeLabel":"enum\u003cstring>"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.provider","typeLabel":"enum\u003cstring>"},"providerErr":{"description":"An error string returned by the provider","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.providerErr","typeLabel":"string"},"providerId":{"description":"The external provider message ID","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.providerId","typeLabel":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.providerRef","typeLabel":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.reactions.items.[INDEX].content","typeLabel":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.reactions.items.[INDEX].userIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.reactions.items.[INDEX].userIds","typeLabel":"string[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.reactions.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.reactions","typeLabel":"object[]"},"readAt":{"description":"When the message was read at by the recipient","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.readAt","typeLabel":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX].actionType","typeLabel":"enum\u003cstring>"},"data":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX].data.additionalProperties","typeLabel":"any"},"type":"object","description":"The data to pass to the action","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX].data","typeLabel":"object"},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX].id","typeLabel":"string"},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX].delay.delay","typeLabel":"integer"},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX].delay.unit","typeLabel":"enum\u003cstring>"}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX].delay","typeLabel":"object"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX].eventData.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX].eventData","typeLabel":"string[]"},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX].order","typeLabel":"integer"}},"required":["actionType","data","id"],"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.actions","typeLabel":"object[]"},"activeHours":{"properties":{"flipLogic":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.flipLogic","typeLabel":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.friday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.friday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.friday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.friday","typeLabel":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.monday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.monday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.monday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.monday","typeLabel":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.saturday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.saturday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.saturday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.saturday","typeLabel":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.sunday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.sunday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.sunday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.sunday","typeLabel":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.thursday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.thursday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.thursday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.thursday","typeLabel":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.timezone","typeLabel":"enum\u003cstring>"},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.tuesday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.tuesday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.tuesday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.tuesday","typeLabel":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.wednesday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.wednesday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.wednesday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours.wednesday","typeLabel":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times.","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.activeHours","typeLabel":"object"},"color":{"description":"The color of the relay","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.color","typeLabel":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions.items.[INDEX].id","typeLabel":"string"},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions.items.[INDEX].logicalOperator","typeLabel":"enum\u003cstring>"},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions.items.[INDEX].useCase","typeLabel":"enum\u003cstring>"},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions.items.[INDEX].caseSensitive","typeLabel":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions.items.[INDEX].matchData.additionalProperties","typeLabel":"any"},"type":"object","description":"Additional match criteria for use cases that require structured data","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions.items.[INDEX].matchData","typeLabel":"object"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions.items.[INDEX].matchValue","typeLabel":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions.items.[INDEX].order","typeLabel":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.conditions","typeLabel":"object[]"},"createdAt":{"description":"The time when the relay was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time when the relay was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.deletedAt","typeLabel":"object"},"description":{"description":"The custom description of the relay","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.description","typeLabel":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.eventName","typeLabel":"enum\u003cstring>"},"icon":{"description":"The icon of the relay","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.icon","typeLabel":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.id","typeLabel":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.lastTriggeredAt","typeLabel":"string"},"name":{"description":"The custom name of the relay","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.name","typeLabel":"string"},"object":{"description":"The object type of the relay","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.object","typeLabel":"string"},"order":{"description":"The order the relay is executed in","type":"integer","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.order","typeLabel":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.pausedAt","typeLabel":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.relayType","typeLabel":"enum\u003cstring>"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.stopOnSuccess","typeLabel":"boolean"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the relay belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.tenantId","typeLabel":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.updatedAt","typeLabel":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.userId","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relay","typeLabel":"object"},"relayId":{"description":"The relay that sent the message","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.relayId","typeLabel":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.segmentCount","typeLabel":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.smsType","typeLabel":"enum\u003cstring>"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.standardErr","typeLabel":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.status","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the message belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.tenantId","typeLabel":"string"},"text":{"description":"The message text","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.text","typeLabel":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].author","typeLabel":"any"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.assignedUserIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.assignedUserIds","typeLabel":"string[]"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.communicationType","typeLabel":"enum\u003cstring>"},"createdAt":{"description":"The time the conversation was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the conversation was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.deletedAt","typeLabel":"object"},"id":{"description":"The unique ulid of the conversation","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.id","typeLabel":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannelAddresses","typeLabel":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].address","typeLabel":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].blockedAt","typeLabel":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].blockedBy","typeLabel":"any"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].blockedById","typeLabel":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].carrier","typeLabel":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].communicationType","typeLabel":"enum\u003cstring>"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].city","typeLabel":"string"},"country":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].country","typeLabel":"string"},"countryCode":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].countryCode","typeLabel":"string"},"defaultBilling":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].defaultBilling","typeLabel":"boolean"},"defaultShipping":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].defaultShipping","typeLabel":"boolean"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].id","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].object","typeLabel":"string"},"postalCode":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].postalCode","typeLabel":"string"},"postalCodeSuffix":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].postalCodeSuffix","typeLabel":"string"},"state":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].state","typeLabel":"string"},"street":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].street","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses","typeLabel":"object[]"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.avatarUrl","typeLabel":"string"},"company":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.company","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.deletedAt","typeLabel":"object"},"firstName":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.firstName","typeLabel":"string"},"flags":{"items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.flags.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.flags","typeLabel":"string[]"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.id","typeLabel":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.inboundChannels","typeLabel":"array"},"lastInboundMessage":{"oneOf":[{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.lastInboundMessage","typeLabel":"any"},"lastInboundMessageTime":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.lastInboundMessageTime","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.lastName","typeLabel":"string"},"lastOutboundMessage":{"oneOf":[{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.lastOutboundMessage","typeLabel":"any"},"lastOutboundMessageTime":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.lastOutboundMessageTime","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.object","typeLabel":"string"},"properties":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.properties.additionalProperties","typeLabel":"any"},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.properties","typeLabel":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.source","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace","typeLabel":"object"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact","typeLabel":"object"},"contactId":{"description":"The id of the contact","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contactId","typeLabel":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].conversations","typeLabel":"array"},"createdAt":{"description":"The date and time the inbound channel was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].deletedAt","typeLabel":"object"},"id":{"description":"The unique identifier for the inbound channel","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].id","typeLabel":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].isDefault","typeLabel":"boolean"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].object","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].updatedAt","typeLabel":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].verifiedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels","typeLabel":"object[]"},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.labels.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.labels","typeLabel":"string[]"},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.lastInboundMessage","typeLabel":"any"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.lastMessage","typeLabel":"any"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.lastMessageTime","typeLabel":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.lastOutboundMessage","typeLabel":"any"},"name":{"description":"The optional name of the conversation","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.name","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.object","typeLabel":"string"},"outboundChannel":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.outboundChannel","typeLabel":"any"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.outboundChannelId","typeLabel":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.status","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.tenantId","typeLabel":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversation","typeLabel":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].conversationId","typeLabel":"string"},"createdAt":{"description":"The time the message was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the message was deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].deletedAt","typeLabel":"object"},"id":{"description":"The unique identifier of the message","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].id","typeLabel":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].media.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].media","typeLabel":"string[]"},"mentions":{"items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].mentions.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].mentions","typeLabel":"string[]"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].object","typeLabel":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].reactions.items.[INDEX].content","typeLabel":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].reactions.items.[INDEX].userIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].reactions.items.[INDEX].userIds","typeLabel":"string[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].reactions.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].reactions","typeLabel":"object[]"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the message belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].tenantId","typeLabel":"string"},"text":{"description":"The message text","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].text","typeLabel":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].thread","typeLabel":"any"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].threadId","typeLabel":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].updatedAt","typeLabel":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].userId","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.comments","typeLabel":"object[]"},"createdAt":{"description":"The time the message was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the message was deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.deletedAt","typeLabel":"object"},"id":{"description":"The unique identifier of the message","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.id","typeLabel":"string"},"lastReplyText":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.lastReplyText","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.object","typeLabel":"string"},"parentId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.parentId","typeLabel":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.parentType","typeLabel":"enum\u003cstring>"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the message belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.tenantId","typeLabel":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread.workspaceId","typeLabel":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.thread","typeLabel":"object"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.to","typeLabel":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.updatedAt","typeLabel":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.userId","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastInboundMessage","typeLabel":"object"},"lastName":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastName","typeLabel":"string"},"lastOutboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.author","typeLabel":"any"},"billable":{"description":"Indicates if the message is billable.","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.billable","typeLabel":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.conversationIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.conversationIds","typeLabel":"string[]"},"createdAt":{"description":"The time the broadcast was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.createdAt","typeLabel":"string"},"createdById":{"description":"The user that created the broadcast","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.createdById","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the broadcast was deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.deletedAt","typeLabel":"object"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.deliveredAt","typeLabel":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.excludeConversationIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.excludeConversationIds","typeLabel":"string[]"},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.excludeGroupIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.excludeGroupIds","typeLabel":"string[]"},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.groupIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.groupIds","typeLabel":"string[]"},"id":{"description":"The unique ulid of the broadcast","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.id","typeLabel":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.media.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.media","typeLabel":"string[]"},"name":{"description":"The name of the broadcast","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.name","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.object","typeLabel":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.scheduleId","typeLabel":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.startedAt","typeLabel":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.status","typeLabel":"enum\u003cstring>"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"The tenant the broadcast belongs to","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.tenantId","typeLabel":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.text","typeLabel":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.totalDelivered","typeLabel":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.totalFailed","typeLabel":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.totalOptedOut","typeLabel":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.totalSent","typeLabel":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.updatedAt","typeLabel":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.user","typeLabel":"any"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","description":"The workspace the broadcast belongs to","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcast","typeLabel":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.broadcastId","typeLabel":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.communicationType","typeLabel":"enum\u003cstring>"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.assignedUserIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.assignedUserIds","typeLabel":"string[]"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.communicationType","typeLabel":"enum\u003cstring>"},"createdAt":{"description":"The time the conversation was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the conversation was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.deletedAt","typeLabel":"object"},"id":{"description":"The unique ulid of the conversation","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.id","typeLabel":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannelAddresses","typeLabel":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].address","typeLabel":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].blockedAt","typeLabel":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].blockedBy","typeLabel":"any"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].blockedById","typeLabel":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].carrier","typeLabel":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].communicationType","typeLabel":"enum\u003cstring>"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].city","typeLabel":"string"},"country":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].country","typeLabel":"string"},"countryCode":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].countryCode","typeLabel":"string"},"defaultBilling":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].defaultBilling","typeLabel":"boolean"},"defaultShipping":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].defaultShipping","typeLabel":"boolean"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].id","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].object","typeLabel":"string"},"postalCode":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].postalCode","typeLabel":"string"},"postalCodeSuffix":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].postalCodeSuffix","typeLabel":"string"},"state":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].state","typeLabel":"string"},"street":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].street","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.addresses","typeLabel":"object[]"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.avatarUrl","typeLabel":"string"},"company":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.company","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.deletedAt","typeLabel":"object"},"firstName":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.firstName","typeLabel":"string"},"flags":{"items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.flags.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.flags","typeLabel":"string[]"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.id","typeLabel":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.inboundChannels","typeLabel":"array"},"lastInboundMessage":{"oneOf":[{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.lastInboundMessage","typeLabel":"any"},"lastInboundMessageTime":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.lastInboundMessageTime","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.lastName","typeLabel":"string"},"lastOutboundMessage":{"oneOf":[{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.lastOutboundMessage","typeLabel":"any"},"lastOutboundMessageTime":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.lastOutboundMessageTime","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.object","typeLabel":"string"},"properties":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.properties.additionalProperties","typeLabel":"any"},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.properties","typeLabel":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.source","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspace","typeLabel":"object"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contact","typeLabel":"object"},"contactId":{"description":"The id of the contact","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].contactId","typeLabel":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].conversations","typeLabel":"array"},"createdAt":{"description":"The date and time the inbound channel was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].deletedAt","typeLabel":"object"},"id":{"description":"The unique identifier for the inbound channel","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].id","typeLabel":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].isDefault","typeLabel":"boolean"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].object","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].updatedAt","typeLabel":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].verifiedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.inboundChannels","typeLabel":"object[]"},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.labels.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.labels","typeLabel":"string[]"},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.lastInboundMessage","typeLabel":"any"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.lastMessage","typeLabel":"any"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.lastMessageTime","typeLabel":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.lastOutboundMessage","typeLabel":"any"},"name":{"description":"The optional name of the conversation","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.name","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.object","typeLabel":"string"},"outboundChannel":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.outboundChannel","typeLabel":"any"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.outboundChannelId","typeLabel":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.status","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.tenantId","typeLabel":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversation","typeLabel":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.conversationId","typeLabel":"string"},"createdAt":{"description":"The time the message was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the message was deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.deletedAt","typeLabel":"object"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.deliveredAt","typeLabel":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].createdAt","typeLabel":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].dataType","typeLabel":"enum\u003cstring>"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The deleted at timestamp","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].deletedAt","typeLabel":"object"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].displayName","typeLabel":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].fallback","typeLabel":"string"},"id":{"description":"The ulid for the tag","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].id","typeLabel":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].key","typeLabel":"string"},"object":{"description":"The object type of the tag","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].object","typeLabel":"string"},"template":{"description":"The templated text we search for in the message","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].template","typeLabel":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].updatedAt","typeLabel":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.fallbacks","typeLabel":"object[]"},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.from","typeLabel":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.group.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.group","typeLabel":"string[]"},"id":{"description":"The unique identifier of the message","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.id","typeLabel":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.media.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.media","typeLabel":"string[]"},"multipartId":{"description":"The provider ID of the multipart message","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.multipartId","typeLabel":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.multipartNum","typeLabel":"integer"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.object","typeLabel":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.outbound","typeLabel":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.priority","typeLabel":"enum\u003cstring>"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.provider","typeLabel":"enum\u003cstring>"},"providerErr":{"description":"An error string returned by the provider","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.providerErr","typeLabel":"string"},"providerId":{"description":"The external provider message ID","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.providerId","typeLabel":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.providerRef","typeLabel":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.reactions.items.[INDEX].content","typeLabel":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.reactions.items.[INDEX].userIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.reactions.items.[INDEX].userIds","typeLabel":"string[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.reactions.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.reactions","typeLabel":"object[]"},"readAt":{"description":"When the message was read at by the recipient","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.readAt","typeLabel":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX].actionType","typeLabel":"enum\u003cstring>"},"data":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX].data.additionalProperties","typeLabel":"any"},"type":"object","description":"The data to pass to the action","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX].data","typeLabel":"object"},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX].id","typeLabel":"string"},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX].delay.delay","typeLabel":"integer"},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX].delay.unit","typeLabel":"enum\u003cstring>"}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX].delay","typeLabel":"object"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX].eventData.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX].eventData","typeLabel":"string[]"},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX].order","typeLabel":"integer"}},"required":["actionType","data","id"],"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.actions","typeLabel":"object[]"},"activeHours":{"properties":{"flipLogic":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.flipLogic","typeLabel":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.friday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.friday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.friday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.friday","typeLabel":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.monday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.monday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.monday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.monday","typeLabel":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.saturday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.saturday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.saturday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.saturday","typeLabel":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.sunday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.sunday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.sunday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.sunday","typeLabel":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.thursday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.thursday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.thursday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.thursday","typeLabel":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.timezone","typeLabel":"enum\u003cstring>"},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.tuesday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.tuesday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.tuesday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.tuesday","typeLabel":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.wednesday.endTime","typeLabel":"string"},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.wednesday.rangeType","typeLabel":"enum\u003cstring>"},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.wednesday.startTime","typeLabel":"string"}},"required":["endTime","rangeType","startTime"],"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours.wednesday","typeLabel":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times.","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.activeHours","typeLabel":"object"},"color":{"description":"The color of the relay","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.color","typeLabel":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions.items.[INDEX].id","typeLabel":"string"},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions.items.[INDEX].logicalOperator","typeLabel":"enum\u003cstring>"},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions.items.[INDEX].useCase","typeLabel":"enum\u003cstring>"},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions.items.[INDEX].caseSensitive","typeLabel":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions.items.[INDEX].matchData.additionalProperties","typeLabel":"any"},"type":"object","description":"Additional match criteria for use cases that require structured data","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions.items.[INDEX].matchData","typeLabel":"object"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions.items.[INDEX].matchValue","typeLabel":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions.items.[INDEX].order","typeLabel":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.conditions","typeLabel":"object[]"},"createdAt":{"description":"The time when the relay was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time when the relay was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.deletedAt","typeLabel":"object"},"description":{"description":"The custom description of the relay","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.description","typeLabel":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.eventName","typeLabel":"enum\u003cstring>"},"icon":{"description":"The icon of the relay","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.icon","typeLabel":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.id","typeLabel":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.lastTriggeredAt","typeLabel":"string"},"name":{"description":"The custom name of the relay","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.name","typeLabel":"string"},"object":{"description":"The object type of the relay","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.object","typeLabel":"string"},"order":{"description":"The order the relay is executed in","type":"integer","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.order","typeLabel":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.pausedAt","typeLabel":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.relayType","typeLabel":"enum\u003cstring>"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.stopOnSuccess","typeLabel":"boolean"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the relay belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.tenantId","typeLabel":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.updatedAt","typeLabel":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.userId","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relay","typeLabel":"object"},"relayId":{"description":"The relay that sent the message","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.relayId","typeLabel":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.segmentCount","typeLabel":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.smsType","typeLabel":"enum\u003cstring>"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.standardErr","typeLabel":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.status","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the message belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.tenantId","typeLabel":"string"},"text":{"description":"The message text","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.text","typeLabel":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].author","typeLabel":"any"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.assignedUserIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.assignedUserIds","typeLabel":"string[]"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.communicationType","typeLabel":"enum\u003cstring>"},"createdAt":{"description":"The time the conversation was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the conversation was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.deletedAt","typeLabel":"object"},"id":{"description":"The unique ulid of the conversation","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.id","typeLabel":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannelAddresses","typeLabel":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].address","typeLabel":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].blockedAt","typeLabel":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].blockedBy","typeLabel":"any"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].blockedById","typeLabel":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].carrier","typeLabel":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].communicationType","typeLabel":"enum\u003cstring>"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].city","typeLabel":"string"},"country":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].country","typeLabel":"string"},"countryCode":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].countryCode","typeLabel":"string"},"defaultBilling":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].defaultBilling","typeLabel":"boolean"},"defaultShipping":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].defaultShipping","typeLabel":"boolean"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].id","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].object","typeLabel":"string"},"postalCode":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].postalCode","typeLabel":"string"},"postalCodeSuffix":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].postalCodeSuffix","typeLabel":"string"},"state":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].state","typeLabel":"string"},"street":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX].street","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.addresses","typeLabel":"object[]"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.avatarUrl","typeLabel":"string"},"company":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.company","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.deletedAt","typeLabel":"object"},"firstName":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.firstName","typeLabel":"string"},"flags":{"items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.flags.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.flags","typeLabel":"string[]"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.id","typeLabel":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.inboundChannels","typeLabel":"array"},"lastInboundMessage":{"oneOf":[{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.lastInboundMessage","typeLabel":"any"},"lastInboundMessageTime":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.lastInboundMessageTime","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.lastName","typeLabel":"string"},"lastOutboundMessage":{"oneOf":[{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.lastOutboundMessage","typeLabel":"any"},"lastOutboundMessageTime":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.lastOutboundMessageTime","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.object","typeLabel":"string"},"properties":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.properties.additionalProperties","typeLabel":"any"},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.properties","typeLabel":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.source","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspace","typeLabel":"object"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contact","typeLabel":"object"},"contactId":{"description":"The id of the contact","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].contactId","typeLabel":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].conversations","typeLabel":"array"},"createdAt":{"description":"The date and time the inbound channel was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].deletedAt","typeLabel":"object"},"id":{"description":"The unique identifier for the inbound channel","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].id","typeLabel":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].isDefault","typeLabel":"boolean"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].object","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].updatedAt","typeLabel":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].verifiedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.inboundChannels","typeLabel":"object[]"},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.labels.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.labels","typeLabel":"string[]"},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.lastInboundMessage","typeLabel":"any"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.lastMessage","typeLabel":"any"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.lastMessageTime","typeLabel":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.lastOutboundMessage","typeLabel":"any"},"name":{"description":"The optional name of the conversation","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.name","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.object","typeLabel":"string"},"outboundChannel":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.outboundChannel","typeLabel":"any"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.outboundChannelId","typeLabel":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.status","typeLabel":"enum\u003cstring>"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.tenantId","typeLabel":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversation","typeLabel":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].conversationId","typeLabel":"string"},"createdAt":{"description":"The time the message was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the message was deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].deletedAt","typeLabel":"object"},"id":{"description":"The unique identifier of the message","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].id","typeLabel":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].media.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].media","typeLabel":"string[]"},"mentions":{"items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].mentions.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].mentions","typeLabel":"string[]"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].object","typeLabel":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].reactions.items.[INDEX].content","typeLabel":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].reactions.items.[INDEX].userIds.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].reactions.items.[INDEX].userIds","typeLabel":"string[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].reactions.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].reactions","typeLabel":"object[]"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the message belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].tenantId","typeLabel":"string"},"text":{"description":"The message text","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].text","typeLabel":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].thread","typeLabel":"any"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].threadId","typeLabel":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].updatedAt","typeLabel":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].userId","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.comments","typeLabel":"object[]"},"createdAt":{"description":"The time the message was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the message was deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.deletedAt","typeLabel":"object"},"id":{"description":"The unique identifier of the message","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.id","typeLabel":"string"},"lastReplyText":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.lastReplyText","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.object","typeLabel":"string"},"parentId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.parentId","typeLabel":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.parentType","typeLabel":"enum\u003cstring>"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.tenant","typeLabel":"any"},"tenantId":{"description":"The tenant the message belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.tenantId","typeLabel":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread.workspaceId","typeLabel":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.thread","typeLabel":"object"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.to","typeLabel":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.updatedAt","typeLabel":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.userId","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.lastOutboundMessage","typeLabel":"object"},"notificationTokens":{"description":"Relationships","items":{"properties":{"createdAt":{"description":"The time the notification token was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.notificationTokens.items.[INDEX].createdAt","typeLabel":"string"},"id":{"description":"The unique identifier for the notification token","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.notificationTokens.items.[INDEX].id","typeLabel":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.notificationTokens.items.[INDEX].object","typeLabel":"enum\u003cstring>"},"token":{"description":"The actual token of the notification token","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.notificationTokens.items.[INDEX].token","typeLabel":"string"},"updatedAt":{"description":"The time the notification token was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.notificationTokens.items.[INDEX].updatedAt","typeLabel":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.notificationTokens.items.[INDEX].user","typeLabel":"any"},"userId":{"description":"The user id that this notification token belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.notificationTokens.items.[INDEX].userId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.notificationTokens.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.notificationTokens","typeLabel":"object[]"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.object","typeLabel":"string"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.phone","typeLabel":"string"},"phoneVerified":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.phoneVerified","typeLabel":"boolean"},"properties":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.properties.additionalProperties","typeLabel":"any"},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.properties","typeLabel":"object"},"ssoProviders":{"items":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.ssoProviders.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.ssoProviders","typeLabel":"string[]"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.userMemberships","typeLabel":"array"},"username":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user.username","typeLabel":"string"}},"type":"object","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].user","typeLabel":"object"},"userId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userId","typeLabel":"string"},"userRole":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole.workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRole","typeLabel":"object"},"userRoleId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userRoleId","typeLabel":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].id","typeLabel":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].object","typeLabel":"enum\u003cstring>"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].updatedAt","typeLabel":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].userId","typeLabel":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].userMembership","typeLabel":"any"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].userMembershipId","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].userSettings","typeLabel":"object[]"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspace","typeLabel":"object"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.userMemberships.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.userMemberships","typeLabel":"object[]"},"workspaces":{"items":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX].workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].tenant.workspaces.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].tenant.workspaces","typeLabel":"object[]"}},"type":"object","description":"Relationships","uniqueKey":"items.[INDEX].tenant","typeLabel":"object"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string","uniqueKey":"items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string","uniqueKey":"items.[INDEX].updatedAt","typeLabel":"string"},"workspace":{"properties":{"address":{"type":"string","uniqueKey":"items.[INDEX].workspace.address","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"items.[INDEX].workspace.avatarUrl","typeLabel":"string"},"color":{"type":"string","uniqueKey":"items.[INDEX].workspace.color","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].workspace.createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].workspace.deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].workspace.deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].workspace.deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].workspace.description","typeLabel":"string"},"email":{"type":"string","uniqueKey":"items.[INDEX].workspace.email","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].workspace.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].workspace.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].workspace.object","typeLabel":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].workspace.outboundChannels","typeLabel":"array"},"phone":{"type":"string","uniqueKey":"items.[INDEX].workspace.phone","typeLabel":"string"},"stateOrProvince":{"type":"string","uniqueKey":"items.[INDEX].workspace.stateOrProvince","typeLabel":"string"},"stripeCustomerId":{"type":"string","uniqueKey":"items.[INDEX].workspace.stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"items.[INDEX].workspace.stripeSubscriptionId","typeLabel":"string"},"tenant":{"oneOf":[{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0"}],"uniqueKey":"items.[INDEX].workspace.tenant","typeLabel":"any"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].workspace.tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].workspace.updatedAt","typeLabel":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].workspace.userMemberships","typeLabel":"array"},"userRoles":{"items":{"properties":{"admin":{"type":"boolean","uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].admin","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].deletedAt","typeLabel":"object"},"description":{"type":"string","uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].id","typeLabel":"string"},"managed":{"type":"boolean","uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].managed","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].object","typeLabel":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of feature names to authorization roles","type":"object","uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].permissions.features","typeLabel":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of labels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].permissions.labels","typeLabel":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of outbound channels ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].permissions.outboundChannels","typeLabel":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"],"uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"A map of user ids to authorization roles","type":"object","uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].permissions.teammates","typeLabel":"object"}},"type":"object","uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].permissions","typeLabel":"object"},"tenantId":{"type":"string","uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].tenantId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].updatedAt","typeLabel":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].userMemberships","typeLabel":"array"},"workspaceId":{"type":"string","uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].workspace.userRoles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].workspace.userRoles","typeLabel":"object[]"},"website":{"type":"string","uniqueKey":"items.[INDEX].workspace.website","typeLabel":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string","uniqueKey":"items.[INDEX].workspace.workspaceSettings.items.[INDEX].createdAt","typeLabel":"string"},"deletedAt":{"properties":{"time":{"type":"string","uniqueKey":"items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.time","typeLabel":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean","uniqueKey":"items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt.valid","typeLabel":"boolean"}},"type":"object","description":"The time the setting was soft deleted","uniqueKey":"items.[INDEX].workspace.workspaceSettings.items.[INDEX].deletedAt","typeLabel":"object"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string","uniqueKey":"items.[INDEX].workspace.workspaceSettings.items.[INDEX].enabled","typeLabel":"string"},"id":{"description":"The unique identifier for the setting","type":"string","uniqueKey":"items.[INDEX].workspace.workspaceSettings.items.[INDEX].id","typeLabel":"string"},"object":{"description":"The object type","type":"string","uniqueKey":"items.[INDEX].workspace.workspaceSettings.items.[INDEX].object","typeLabel":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].workspace.workspaceSettings.items.[INDEX].tenantId","typeLabel":"string"},"title":{"description":"The display name of the setting","type":"string","uniqueKey":"items.[INDEX].workspace.workspaceSettings.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field","uniqueKey":"items.[INDEX].workspace.workspaceSettings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"The time the setting was last updated","type":"string","uniqueKey":"items.[INDEX].workspace.workspaceSettings.items.[INDEX].updatedAt","typeLabel":"string"},"value":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"items.[INDEX].workspace.workspaceSettings.items.[INDEX].value.additionalProperties","typeLabel":"any"},"type":"object","description":"The the generic data for the specific setting type","uniqueKey":"items.[INDEX].workspace.workspaceSettings.items.[INDEX].value","typeLabel":"object"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string","uniqueKey":"items.[INDEX].workspace.workspaceSettings.items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX].workspace.workspaceSettings.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueItems":false,"uniqueKey":"items.[INDEX].workspace.workspaceSettings","typeLabel":"object[]"}},"type":"object","uniqueKey":"items.[INDEX].workspace","typeLabel":"object"},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string","uniqueKey":"items.[INDEX].workspaceId","typeLabel":"string"}},"type":"object","uniqueKey":"items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"","typeLabel":"object[]"},"examples":{"Example":{"title":"Example","value":[{"address":"\u003cstring>","communicationType":"chat","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","newMessagesCount":123,"object":"\u003cstring>","smsNumber":{"callForwardingNumber":"\u003cstring>","campaignId":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","metaData":{},"number":"\u003cstring>","object":"\u003cstring>","outboundChannel":"\u003cunknown>","outboundChannelId":"\u003cstring>","provider":"bandwidth","status":"assigned","tenant":{"companyAddress":"\u003cstring>","companyDescription":"\u003cstring>","companyEmail":"\u003cstring>","companyLogo":"\u003cstring>","companyName":"\u003cstring>","companyPhone":"\u003cstring>","companyWebsite":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","object":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","invitations":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"expiredAt":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","status":"active","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMembership":"\u003cunknown>","userMembershipId":"\u003cstring>","workspaceId":"\u003cstring>"}],"object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"status":"active","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","user":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","cognitoId":"\u003cstring>","company":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"email":"\u003cstring>","emailVerified":true,"firstName":"\u003cstring>","id":"\u003cstring>","lastInboundMessage":{"author":"\u003cunknown>","billable":true,"broadcast":{"conversationIds":["\u003cstring>"],"createdAt":"\u003cstring>","createdById":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"deliveredAt":"\u003cstring>","excludeConversationIds":["\u003cstring>"],"excludeGroupIds":["\u003cstring>"],"groupIds":["\u003cstring>"],"id":"\u003cstring>","media":["\u003cstring>"],"name":"\u003cstring>","object":"\u003cstring>","scheduleId":"\u003cstring>","startedAt":"\u003cstring>","status":"created","tenant":"\u003cunknown>","tenantId":"\u003cstring>","text":"\u003cstring>","totalDelivered":123,"totalFailed":123,"totalOptedOut":123,"totalSent":123,"updatedAt":"\u003cstring>","user":"\u003cunknown>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"broadcastId":"\u003cstring>","communicationType":"chat","conversation":{"assignedUserIds":["\u003cstring>"],"communicationType":"chat","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","inboundChannelAddresses":"\u003cstring>","inboundChannels":[{"address":"\u003cstring>","blockedAt":"\u003cstring>","blockedBy":"\u003cunknown>","blockedById":"\u003cstring>","carrier":"\u003cstring>","communicationType":"chat","contact":{"addresses":[{"city":"\u003cstring>","country":"\u003cstring>","countryCode":"\u003cstring>","defaultBilling":true,"defaultShipping":true,"id":"\u003cstring>","object":"\u003cstring>","postalCode":"\u003cstring>","postalCodeSuffix":"\u003cstring>","state":"\u003cstring>","street":"\u003cstring>"}],"avatarUrl":"\u003cstring>","company":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"firstName":"\u003cstring>","flags":["\u003cstring>"],"id":"\u003cstring>","inboundChannels":"\u003carray>","lastInboundMessage":"\u003cunknown>","lastInboundMessageTime":"\u003cstring>","lastName":"\u003cstring>","lastOutboundMessage":"\u003cunknown>","lastOutboundMessageTime":"\u003cstring>","object":"\u003cstring>","properties":{},"source":"chat","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"contactId":"\u003cstring>","conversations":"\u003carray>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","isDefault":true,"object":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","verifiedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"}],"labels":["\u003cstring>"],"lastInboundMessage":"\u003cunknown>","lastMessage":"\u003cunknown>","lastMessageTime":"\u003cstring>","lastOutboundMessage":"\u003cunknown>","name":"\u003cstring>","object":"\u003cstring>","outboundChannel":"\u003cunknown>","outboundChannelId":"\u003cstring>","status":"closed","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"conversationId":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"deliveredAt":"\u003cstring>","fallbacks":[{"createdAt":"\u003cstring>","dataType":"BandwidthWebhook","deletedAt":{"time":"\u003cstring>","valid":true},"displayName":"\u003cstring>","fallback":"\u003cstring>","id":"\u003cstring>","key":"\u003cstring>","object":"\u003cstring>","template":"\u003cstring>","updatedAt":"\u003cstring>","workspaceId":"\u003cstring>"}],"from":"\u003cstring>","group":["\u003cstring>"],"id":"\u003cstring>","media":["\u003cstring>"],"multipartId":"\u003cstring>","multipartNum":123,"object":"\u003cstring>","outbound":true,"priority":"normal","provider":"bandwidth","providerErr":"\u003cstring>","providerId":"\u003cstring>","providerRef":"\u003cstring>","reactions":[{"content":"\u003cstring>","userIds":["\u003cstring>"]}],"readAt":"\u003cstring>","relay":{"actions":[{"actionType":"assignTeammates","data":{},"id":"\u003cstring>","delay":{"delay":2,"unit":"minute"},"eventData":["\u003cstring>"],"order":1}],"activeHours":{"flipLogic":true,"friday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"monday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"saturday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"sunday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"thursday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"timezone":"America/Los_Angeles","tuesday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"wednesday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"}},"color":"\u003cstring>","conditions":[{"id":"\u003cstring>","logicalOperator":"AND","operator":"contains","useCase":"MessageContainsText","caseSensitive":true,"matchData":{},"matchValue":"\u003cstring>","order":1}],"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","eventName":"AddRemoveOptOutRequest","icon":"\u003cstring>","id":"\u003cstring>","lastTriggeredAt":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","order":123,"pausedAt":"\u003cstring>","relayType":"workspace","stopOnSuccess":true,"tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userId":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"relayId":"\u003cstring>","segmentCount":123,"smsType":"sms","standardErr":123,"status":"blocked","tenant":"\u003cunknown>","tenantId":"\u003cstring>","text":"\u003cstring>","thread":{"comments":[{"author":"\u003cunknown>","conversation":{"assignedUserIds":["\u003cstring>"],"communicationType":"chat","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","inboundChannelAddresses":"\u003cstring>","inboundChannels":[{"address":"\u003cstring>","blockedAt":"\u003cstring>","blockedBy":"\u003cunknown>","blockedById":"\u003cstring>","carrier":"\u003cstring>","communicationType":"chat","contact":{"addresses":[{"city":"\u003cstring>","country":"\u003cstring>","countryCode":"\u003cstring>","defaultBilling":true,"defaultShipping":true,"id":"\u003cstring>","object":"\u003cstring>","postalCode":"\u003cstring>","postalCodeSuffix":"\u003cstring>","state":"\u003cstring>","street":"\u003cstring>"}],"avatarUrl":"\u003cstring>","company":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"firstName":"\u003cstring>","flags":["\u003cstring>"],"id":"\u003cstring>","inboundChannels":"\u003carray>","lastInboundMessage":"\u003cunknown>","lastInboundMessageTime":"\u003cstring>","lastName":"\u003cstring>","lastOutboundMessage":"\u003cunknown>","lastOutboundMessageTime":"\u003cstring>","object":"\u003cstring>","properties":{},"source":"chat","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"contactId":"\u003cstring>","conversations":"\u003carray>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","isDefault":true,"object":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","verifiedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"}],"labels":["\u003cstring>"],"lastInboundMessage":"\u003cunknown>","lastMessage":"\u003cunknown>","lastMessageTime":"\u003cstring>","lastOutboundMessage":"\u003cunknown>","name":"\u003cstring>","object":"\u003cstring>","outboundChannel":"\u003cunknown>","outboundChannelId":"\u003cstring>","status":"closed","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"conversationId":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","media":["\u003cstring>"],"mentions":["\u003cstring>"],"object":"\u003cstring>","reactions":[{"content":"\u003cstring>","userIds":["\u003cstring>"]}],"tenant":"\u003cunknown>","tenantId":"\u003cstring>","text":"\u003cstring>","thread":"\u003cunknown>","threadId":"\u003cstring>","updatedAt":"\u003cstring>","userId":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"}],"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","lastReplyText":"\u003cstring>","object":"\u003cstring>","parentId":"\u003cstring>","parentType":"BandwidthWebhook","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"to":"\u003cstring>","updatedAt":"\u003cstring>","userId":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"lastName":"\u003cstring>","lastOutboundMessage":{"author":"\u003cunknown>","billable":true,"broadcast":{"conversationIds":["\u003cstring>"],"createdAt":"\u003cstring>","createdById":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"deliveredAt":"\u003cstring>","excludeConversationIds":["\u003cstring>"],"excludeGroupIds":["\u003cstring>"],"groupIds":["\u003cstring>"],"id":"\u003cstring>","media":["\u003cstring>"],"name":"\u003cstring>","object":"\u003cstring>","scheduleId":"\u003cstring>","startedAt":"\u003cstring>","status":"created","tenant":"\u003cunknown>","tenantId":"\u003cstring>","text":"\u003cstring>","totalDelivered":123,"totalFailed":123,"totalOptedOut":123,"totalSent":123,"updatedAt":"\u003cstring>","user":"\u003cunknown>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"broadcastId":"\u003cstring>","communicationType":"chat","conversation":{"assignedUserIds":["\u003cstring>"],"communicationType":"chat","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","inboundChannelAddresses":"\u003cstring>","inboundChannels":[{"address":"\u003cstring>","blockedAt":"\u003cstring>","blockedBy":"\u003cunknown>","blockedById":"\u003cstring>","carrier":"\u003cstring>","communicationType":"chat","contact":{"addresses":[{"city":"\u003cstring>","country":"\u003cstring>","countryCode":"\u003cstring>","defaultBilling":true,"defaultShipping":true,"id":"\u003cstring>","object":"\u003cstring>","postalCode":"\u003cstring>","postalCodeSuffix":"\u003cstring>","state":"\u003cstring>","street":"\u003cstring>"}],"avatarUrl":"\u003cstring>","company":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"firstName":"\u003cstring>","flags":["\u003cstring>"],"id":"\u003cstring>","inboundChannels":"\u003carray>","lastInboundMessage":"\u003cunknown>","lastInboundMessageTime":"\u003cstring>","lastName":"\u003cstring>","lastOutboundMessage":"\u003cunknown>","lastOutboundMessageTime":"\u003cstring>","object":"\u003cstring>","properties":{},"source":"chat","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"contactId":"\u003cstring>","conversations":"\u003carray>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","isDefault":true,"object":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","verifiedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"}],"labels":["\u003cstring>"],"lastInboundMessage":"\u003cunknown>","lastMessage":"\u003cunknown>","lastMessageTime":"\u003cstring>","lastOutboundMessage":"\u003cunknown>","name":"\u003cstring>","object":"\u003cstring>","outboundChannel":"\u003cunknown>","outboundChannelId":"\u003cstring>","status":"closed","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"conversationId":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"deliveredAt":"\u003cstring>","fallbacks":[{"createdAt":"\u003cstring>","dataType":"BandwidthWebhook","deletedAt":{"time":"\u003cstring>","valid":true},"displayName":"\u003cstring>","fallback":"\u003cstring>","id":"\u003cstring>","key":"\u003cstring>","object":"\u003cstring>","template":"\u003cstring>","updatedAt":"\u003cstring>","workspaceId":"\u003cstring>"}],"from":"\u003cstring>","group":["\u003cstring>"],"id":"\u003cstring>","media":["\u003cstring>"],"multipartId":"\u003cstring>","multipartNum":123,"object":"\u003cstring>","outbound":true,"priority":"normal","provider":"bandwidth","providerErr":"\u003cstring>","providerId":"\u003cstring>","providerRef":"\u003cstring>","reactions":[{"content":"\u003cstring>","userIds":["\u003cstring>"]}],"readAt":"\u003cstring>","relay":{"actions":[{"actionType":"assignTeammates","data":{},"id":"\u003cstring>","delay":{"delay":2,"unit":"minute"},"eventData":["\u003cstring>"],"order":1}],"activeHours":{"flipLogic":true,"friday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"monday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"saturday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"sunday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"thursday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"timezone":"America/Los_Angeles","tuesday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"wednesday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"}},"color":"\u003cstring>","conditions":[{"id":"\u003cstring>","logicalOperator":"AND","operator":"contains","useCase":"MessageContainsText","caseSensitive":true,"matchData":{},"matchValue":"\u003cstring>","order":1}],"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","eventName":"AddRemoveOptOutRequest","icon":"\u003cstring>","id":"\u003cstring>","lastTriggeredAt":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","order":123,"pausedAt":"\u003cstring>","relayType":"workspace","stopOnSuccess":true,"tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userId":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"relayId":"\u003cstring>","segmentCount":123,"smsType":"sms","standardErr":123,"status":"blocked","tenant":"\u003cunknown>","tenantId":"\u003cstring>","text":"\u003cstring>","thread":{"comments":[{"author":"\u003cunknown>","conversation":{"assignedUserIds":["\u003cstring>"],"communicationType":"chat","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","inboundChannelAddresses":"\u003cstring>","inboundChannels":[{"address":"\u003cstring>","blockedAt":"\u003cstring>","blockedBy":"\u003cunknown>","blockedById":"\u003cstring>","carrier":"\u003cstring>","communicationType":"chat","contact":{"addresses":[{"city":"\u003cstring>","country":"\u003cstring>","countryCode":"\u003cstring>","defaultBilling":true,"defaultShipping":true,"id":"\u003cstring>","object":"\u003cstring>","postalCode":"\u003cstring>","postalCodeSuffix":"\u003cstring>","state":"\u003cstring>","street":"\u003cstring>"}],"avatarUrl":"\u003cstring>","company":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"firstName":"\u003cstring>","flags":["\u003cstring>"],"id":"\u003cstring>","inboundChannels":"\u003carray>","lastInboundMessage":"\u003cunknown>","lastInboundMessageTime":"\u003cstring>","lastName":"\u003cstring>","lastOutboundMessage":"\u003cunknown>","lastOutboundMessageTime":"\u003cstring>","object":"\u003cstring>","properties":{},"source":"chat","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"contactId":"\u003cstring>","conversations":"\u003carray>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","isDefault":true,"object":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","verifiedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"}],"labels":["\u003cstring>"],"lastInboundMessage":"\u003cunknown>","lastMessage":"\u003cunknown>","lastMessageTime":"\u003cstring>","lastOutboundMessage":"\u003cunknown>","name":"\u003cstring>","object":"\u003cstring>","outboundChannel":"\u003cunknown>","outboundChannelId":"\u003cstring>","status":"closed","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"conversationId":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","media":["\u003cstring>"],"mentions":["\u003cstring>"],"object":"\u003cstring>","reactions":[{"content":"\u003cstring>","userIds":["\u003cstring>"]}],"tenant":"\u003cunknown>","tenantId":"\u003cstring>","text":"\u003cstring>","thread":"\u003cunknown>","threadId":"\u003cstring>","updatedAt":"\u003cstring>","userId":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"}],"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","lastReplyText":"\u003cstring>","object":"\u003cstring>","parentId":"\u003cstring>","parentType":"BandwidthWebhook","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"to":"\u003cstring>","updatedAt":"\u003cstring>","userId":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"notificationTokens":[{"createdAt":"\u003cstring>","id":"\u003cstring>","object":"BandwidthWebhook","token":"\u003cstring>","updatedAt":"\u003cstring>","user":"\u003cunknown>","userId":"\u003cstring>"}],"object":"\u003cstring>","phone":"\u003cstring>","phoneVerified":true,"properties":{},"ssoProviders":["\u003cstring>"],"updatedAt":"\u003cstring>","userMemberships":"\u003carray>","username":"\u003cstring>"},"userId":"\u003cstring>","userRole":{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"},"userRoleId":"\u003cstring>","userSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"BandwidthWebhook","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","userId":"\u003cstring>","userMembership":"\u003cunknown>","userMembershipId":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}],"workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"}],"workspaces":[{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]}]},"tenantId":"\u003cstring>","tollFree":true,"updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"tenant":{"companyAddress":"\u003cstring>","companyDescription":"\u003cstring>","companyEmail":"\u003cstring>","companyLogo":"\u003cstring>","companyName":"\u003cstring>","companyPhone":"\u003cstring>","companyWebsite":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","object":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","invitations":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"expiredAt":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","status":"active","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMembership":"\u003cunknown>","userMembershipId":"\u003cstring>","workspaceId":"\u003cstring>"}],"object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"status":"active","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","user":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","cognitoId":"\u003cstring>","company":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"email":"\u003cstring>","emailVerified":true,"firstName":"\u003cstring>","id":"\u003cstring>","lastInboundMessage":{"author":"\u003cunknown>","billable":true,"broadcast":{"conversationIds":["\u003cstring>"],"createdAt":"\u003cstring>","createdById":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"deliveredAt":"\u003cstring>","excludeConversationIds":["\u003cstring>"],"excludeGroupIds":["\u003cstring>"],"groupIds":["\u003cstring>"],"id":"\u003cstring>","media":["\u003cstring>"],"name":"\u003cstring>","object":"\u003cstring>","scheduleId":"\u003cstring>","startedAt":"\u003cstring>","status":"created","tenant":"\u003cunknown>","tenantId":"\u003cstring>","text":"\u003cstring>","totalDelivered":123,"totalFailed":123,"totalOptedOut":123,"totalSent":123,"updatedAt":"\u003cstring>","user":"\u003cunknown>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"broadcastId":"\u003cstring>","communicationType":"chat","conversation":{"assignedUserIds":["\u003cstring>"],"communicationType":"chat","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","inboundChannelAddresses":"\u003cstring>","inboundChannels":[{"address":"\u003cstring>","blockedAt":"\u003cstring>","blockedBy":"\u003cunknown>","blockedById":"\u003cstring>","carrier":"\u003cstring>","communicationType":"chat","contact":{"addresses":[{"city":"\u003cstring>","country":"\u003cstring>","countryCode":"\u003cstring>","defaultBilling":true,"defaultShipping":true,"id":"\u003cstring>","object":"\u003cstring>","postalCode":"\u003cstring>","postalCodeSuffix":"\u003cstring>","state":"\u003cstring>","street":"\u003cstring>"}],"avatarUrl":"\u003cstring>","company":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"firstName":"\u003cstring>","flags":["\u003cstring>"],"id":"\u003cstring>","inboundChannels":"\u003carray>","lastInboundMessage":"\u003cunknown>","lastInboundMessageTime":"\u003cstring>","lastName":"\u003cstring>","lastOutboundMessage":"\u003cunknown>","lastOutboundMessageTime":"\u003cstring>","object":"\u003cstring>","properties":{},"source":"chat","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"contactId":"\u003cstring>","conversations":"\u003carray>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","isDefault":true,"object":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","verifiedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"}],"labels":["\u003cstring>"],"lastInboundMessage":"\u003cunknown>","lastMessage":"\u003cunknown>","lastMessageTime":"\u003cstring>","lastOutboundMessage":"\u003cunknown>","name":"\u003cstring>","object":"\u003cstring>","outboundChannel":"\u003cunknown>","outboundChannelId":"\u003cstring>","status":"closed","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"conversationId":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"deliveredAt":"\u003cstring>","fallbacks":[{"createdAt":"\u003cstring>","dataType":"BandwidthWebhook","deletedAt":{"time":"\u003cstring>","valid":true},"displayName":"\u003cstring>","fallback":"\u003cstring>","id":"\u003cstring>","key":"\u003cstring>","object":"\u003cstring>","template":"\u003cstring>","updatedAt":"\u003cstring>","workspaceId":"\u003cstring>"}],"from":"\u003cstring>","group":["\u003cstring>"],"id":"\u003cstring>","media":["\u003cstring>"],"multipartId":"\u003cstring>","multipartNum":123,"object":"\u003cstring>","outbound":true,"priority":"normal","provider":"bandwidth","providerErr":"\u003cstring>","providerId":"\u003cstring>","providerRef":"\u003cstring>","reactions":[{"content":"\u003cstring>","userIds":["\u003cstring>"]}],"readAt":"\u003cstring>","relay":{"actions":[{"actionType":"assignTeammates","data":{},"id":"\u003cstring>","delay":{"delay":2,"unit":"minute"},"eventData":["\u003cstring>"],"order":1}],"activeHours":{"flipLogic":true,"friday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"monday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"saturday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"sunday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"thursday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"timezone":"America/Los_Angeles","tuesday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"wednesday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"}},"color":"\u003cstring>","conditions":[{"id":"\u003cstring>","logicalOperator":"AND","operator":"contains","useCase":"MessageContainsText","caseSensitive":true,"matchData":{},"matchValue":"\u003cstring>","order":1}],"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","eventName":"AddRemoveOptOutRequest","icon":"\u003cstring>","id":"\u003cstring>","lastTriggeredAt":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","order":123,"pausedAt":"\u003cstring>","relayType":"workspace","stopOnSuccess":true,"tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userId":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"relayId":"\u003cstring>","segmentCount":123,"smsType":"sms","standardErr":123,"status":"blocked","tenant":"\u003cunknown>","tenantId":"\u003cstring>","text":"\u003cstring>","thread":{"comments":[{"author":"\u003cunknown>","conversation":{"assignedUserIds":["\u003cstring>"],"communicationType":"chat","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","inboundChannelAddresses":"\u003cstring>","inboundChannels":[{"address":"\u003cstring>","blockedAt":"\u003cstring>","blockedBy":"\u003cunknown>","blockedById":"\u003cstring>","carrier":"\u003cstring>","communicationType":"chat","contact":{"addresses":[{"city":"\u003cstring>","country":"\u003cstring>","countryCode":"\u003cstring>","defaultBilling":true,"defaultShipping":true,"id":"\u003cstring>","object":"\u003cstring>","postalCode":"\u003cstring>","postalCodeSuffix":"\u003cstring>","state":"\u003cstring>","street":"\u003cstring>"}],"avatarUrl":"\u003cstring>","company":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"firstName":"\u003cstring>","flags":["\u003cstring>"],"id":"\u003cstring>","inboundChannels":"\u003carray>","lastInboundMessage":"\u003cunknown>","lastInboundMessageTime":"\u003cstring>","lastName":"\u003cstring>","lastOutboundMessage":"\u003cunknown>","lastOutboundMessageTime":"\u003cstring>","object":"\u003cstring>","properties":{},"source":"chat","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"contactId":"\u003cstring>","conversations":"\u003carray>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","isDefault":true,"object":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","verifiedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"}],"labels":["\u003cstring>"],"lastInboundMessage":"\u003cunknown>","lastMessage":"\u003cunknown>","lastMessageTime":"\u003cstring>","lastOutboundMessage":"\u003cunknown>","name":"\u003cstring>","object":"\u003cstring>","outboundChannel":"\u003cunknown>","outboundChannelId":"\u003cstring>","status":"closed","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"conversationId":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","media":["\u003cstring>"],"mentions":["\u003cstring>"],"object":"\u003cstring>","reactions":[{"content":"\u003cstring>","userIds":["\u003cstring>"]}],"tenant":"\u003cunknown>","tenantId":"\u003cstring>","text":"\u003cstring>","thread":"\u003cunknown>","threadId":"\u003cstring>","updatedAt":"\u003cstring>","userId":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"}],"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","lastReplyText":"\u003cstring>","object":"\u003cstring>","parentId":"\u003cstring>","parentType":"BandwidthWebhook","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"to":"\u003cstring>","updatedAt":"\u003cstring>","userId":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"lastName":"\u003cstring>","lastOutboundMessage":{"author":"\u003cunknown>","billable":true,"broadcast":{"conversationIds":["\u003cstring>"],"createdAt":"\u003cstring>","createdById":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"deliveredAt":"\u003cstring>","excludeConversationIds":["\u003cstring>"],"excludeGroupIds":["\u003cstring>"],"groupIds":["\u003cstring>"],"id":"\u003cstring>","media":["\u003cstring>"],"name":"\u003cstring>","object":"\u003cstring>","scheduleId":"\u003cstring>","startedAt":"\u003cstring>","status":"created","tenant":"\u003cunknown>","tenantId":"\u003cstring>","text":"\u003cstring>","totalDelivered":123,"totalFailed":123,"totalOptedOut":123,"totalSent":123,"updatedAt":"\u003cstring>","user":"\u003cunknown>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"broadcastId":"\u003cstring>","communicationType":"chat","conversation":{"assignedUserIds":["\u003cstring>"],"communicationType":"chat","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","inboundChannelAddresses":"\u003cstring>","inboundChannels":[{"address":"\u003cstring>","blockedAt":"\u003cstring>","blockedBy":"\u003cunknown>","blockedById":"\u003cstring>","carrier":"\u003cstring>","communicationType":"chat","contact":{"addresses":[{"city":"\u003cstring>","country":"\u003cstring>","countryCode":"\u003cstring>","defaultBilling":true,"defaultShipping":true,"id":"\u003cstring>","object":"\u003cstring>","postalCode":"\u003cstring>","postalCodeSuffix":"\u003cstring>","state":"\u003cstring>","street":"\u003cstring>"}],"avatarUrl":"\u003cstring>","company":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"firstName":"\u003cstring>","flags":["\u003cstring>"],"id":"\u003cstring>","inboundChannels":"\u003carray>","lastInboundMessage":"\u003cunknown>","lastInboundMessageTime":"\u003cstring>","lastName":"\u003cstring>","lastOutboundMessage":"\u003cunknown>","lastOutboundMessageTime":"\u003cstring>","object":"\u003cstring>","properties":{},"source":"chat","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"contactId":"\u003cstring>","conversations":"\u003carray>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","isDefault":true,"object":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","verifiedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"}],"labels":["\u003cstring>"],"lastInboundMessage":"\u003cunknown>","lastMessage":"\u003cunknown>","lastMessageTime":"\u003cstring>","lastOutboundMessage":"\u003cunknown>","name":"\u003cstring>","object":"\u003cstring>","outboundChannel":"\u003cunknown>","outboundChannelId":"\u003cstring>","status":"closed","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"conversationId":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"deliveredAt":"\u003cstring>","fallbacks":[{"createdAt":"\u003cstring>","dataType":"BandwidthWebhook","deletedAt":{"time":"\u003cstring>","valid":true},"displayName":"\u003cstring>","fallback":"\u003cstring>","id":"\u003cstring>","key":"\u003cstring>","object":"\u003cstring>","template":"\u003cstring>","updatedAt":"\u003cstring>","workspaceId":"\u003cstring>"}],"from":"\u003cstring>","group":["\u003cstring>"],"id":"\u003cstring>","media":["\u003cstring>"],"multipartId":"\u003cstring>","multipartNum":123,"object":"\u003cstring>","outbound":true,"priority":"normal","provider":"bandwidth","providerErr":"\u003cstring>","providerId":"\u003cstring>","providerRef":"\u003cstring>","reactions":[{"content":"\u003cstring>","userIds":["\u003cstring>"]}],"readAt":"\u003cstring>","relay":{"actions":[{"actionType":"assignTeammates","data":{},"id":"\u003cstring>","delay":{"delay":2,"unit":"minute"},"eventData":["\u003cstring>"],"order":1}],"activeHours":{"flipLogic":true,"friday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"monday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"saturday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"sunday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"thursday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"timezone":"America/Los_Angeles","tuesday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"},"wednesday":{"endTime":"\u003cstring>","rangeType":"openAllDay","startTime":"\u003cstring>"}},"color":"\u003cstring>","conditions":[{"id":"\u003cstring>","logicalOperator":"AND","operator":"contains","useCase":"MessageContainsText","caseSensitive":true,"matchData":{},"matchValue":"\u003cstring>","order":1}],"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","eventName":"AddRemoveOptOutRequest","icon":"\u003cstring>","id":"\u003cstring>","lastTriggeredAt":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","order":123,"pausedAt":"\u003cstring>","relayType":"workspace","stopOnSuccess":true,"tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userId":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"relayId":"\u003cstring>","segmentCount":123,"smsType":"sms","standardErr":123,"status":"blocked","tenant":"\u003cunknown>","tenantId":"\u003cstring>","text":"\u003cstring>","thread":{"comments":[{"author":"\u003cunknown>","conversation":{"assignedUserIds":["\u003cstring>"],"communicationType":"chat","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","inboundChannelAddresses":"\u003cstring>","inboundChannels":[{"address":"\u003cstring>","blockedAt":"\u003cstring>","blockedBy":"\u003cunknown>","blockedById":"\u003cstring>","carrier":"\u003cstring>","communicationType":"chat","contact":{"addresses":[{"city":"\u003cstring>","country":"\u003cstring>","countryCode":"\u003cstring>","defaultBilling":true,"defaultShipping":true,"id":"\u003cstring>","object":"\u003cstring>","postalCode":"\u003cstring>","postalCodeSuffix":"\u003cstring>","state":"\u003cstring>","street":"\u003cstring>"}],"avatarUrl":"\u003cstring>","company":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"firstName":"\u003cstring>","flags":["\u003cstring>"],"id":"\u003cstring>","inboundChannels":"\u003carray>","lastInboundMessage":"\u003cunknown>","lastInboundMessageTime":"\u003cstring>","lastName":"\u003cstring>","lastOutboundMessage":"\u003cunknown>","lastOutboundMessageTime":"\u003cstring>","object":"\u003cstring>","properties":{},"source":"chat","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"contactId":"\u003cstring>","conversations":"\u003carray>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","isDefault":true,"object":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","verifiedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"}],"labels":["\u003cstring>"],"lastInboundMessage":"\u003cunknown>","lastMessage":"\u003cunknown>","lastMessageTime":"\u003cstring>","lastOutboundMessage":"\u003cunknown>","name":"\u003cstring>","object":"\u003cstring>","outboundChannel":"\u003cunknown>","outboundChannelId":"\u003cstring>","status":"closed","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"conversationId":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","media":["\u003cstring>"],"mentions":["\u003cstring>"],"object":"\u003cstring>","reactions":[{"content":"\u003cstring>","userIds":["\u003cstring>"]}],"tenant":"\u003cunknown>","tenantId":"\u003cstring>","text":"\u003cstring>","thread":"\u003cunknown>","threadId":"\u003cstring>","updatedAt":"\u003cstring>","userId":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"}],"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"id":"\u003cstring>","lastReplyText":"\u003cstring>","object":"\u003cstring>","parentId":"\u003cstring>","parentType":"BandwidthWebhook","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"to":"\u003cstring>","updatedAt":"\u003cstring>","userId":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"},"notificationTokens":[{"createdAt":"\u003cstring>","id":"\u003cstring>","object":"BandwidthWebhook","token":"\u003cstring>","updatedAt":"\u003cstring>","user":"\u003cunknown>","userId":"\u003cstring>"}],"object":"\u003cstring>","phone":"\u003cstring>","phoneVerified":true,"properties":{},"ssoProviders":["\u003cstring>"],"updatedAt":"\u003cstring>","userMemberships":"\u003carray>","username":"\u003cstring>"},"userId":"\u003cstring>","userRole":{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"},"userRoleId":"\u003cstring>","userSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"BandwidthWebhook","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","userId":"\u003cstring>","userMembership":"\u003cunknown>","userMembershipId":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}],"workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"}],"workspaces":[{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]}]},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","workspace":{"address":"\u003cstring>","avatarUrl":"\u003cstring>","color":"\u003cstring>","createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","email":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","outboundChannels":"\u003carray>","phone":"\u003cstring>","stateOrProvince":"\u003cstring>","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","tenant":"\u003cunknown>","tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","userRoles":[{"admin":true,"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"description":"\u003cstring>","id":"\u003cstring>","managed":true,"name":"\u003cstring>","object":"\u003cstring>","permissions":{"features":{},"labels":{},"outboundChannels":{},"teammates":{}},"tenantId":"\u003cstring>","updatedAt":"\u003cstring>","userMemberships":"\u003carray>","workspaceId":"\u003cstring>"}],"website":"\u003cstring>","workspaceSettings":[{"createdAt":"\u003cstring>","deletedAt":{"time":"\u003cstring>","valid":true},"enabled":"\u003cstring>","id":"\u003cstring>","object":"\u003cstring>","tenantId":"\u003cstring>","title":"\u003cstring>","type":"BandwidthWebhook","updatedAt":"\u003cstring>","value":{},"workspaceId":"\u003cstring>"}]},"workspaceId":"\u003cstring>"}]}},"exampleType":"generated"}},"description":"OK","exampleType":"generated"},"2b267ef9-117a-426a-8820-bb0505bdb2f0":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Human-readable description of the failure","example":"workspace not found","type":"string","uniqueKey":"error","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"workspace not found"}}},"exampleType":"generated"}},"description":"Missing or invalid bearer token","exampleType":"generated"},"78666f0b-eac7-459e-8d15-f6fd6b9a0030":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Human-readable description of the failure","example":"workspace not found","type":"string","uniqueKey":"error","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"workspace not found"}}},"exampleType":"generated"}},"description":"The authenticated user is not a member of the workspace","exampleType":"generated"},"e4237fa9-ffa0-45bb-b875-1c6a9737f290":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Human-readable description of the failure","example":"workspace not found","type":"string","uniqueKey":"error","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"workspace not found"}}},"exampleType":"generated"}},"description":"Workspace or referenced record not found","exampleType":"generated"},"bb565f55-ff5e-4922-8bda-0d497532c6a1":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Human-readable description of the failure","example":"workspace not found","type":"string","uniqueKey":"error","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"workspace not found"}}},"exampleType":"generated"}},"description":"Internal Server Error","exampleType":"generated"}},"security":{"e670cbcd-1aaa-4e4d-8dca-9e9d8661226d":{"BearerAuth":{"bearerFormat":"JWT","description":"An OAuth 2.0 access token, sent as `Authorization: Bearer \u003ctoken>`. MessageDesk is the OAuth 2.0 provider (backed by AWS Cognito): an integration such as Zapier obtains the token through the authorization-code flow when a user connects their MessageDesk account. Access tokens are valid for 24 hours and are refreshed with the refresh token.","scheme":"bearer","type":"http","scopes":[]}}},"servers":{"12b75418-4d7b-4431-88cb-59f1067641fe":{"description":"Production","url":"https://c3uezq47el.execute-api.us-west-2.amazonaws.com/main"}},"schemas":{"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"cognitoId":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"email":{"type":"string"},"emailVerified":{"type":"boolean"},"firstName":{"type":"string"},"id":{"type":"string"},"lastInboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"lastName":{"type":"string"},"lastOutboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"notificationTokens":{"description":"Relationships","items":{"properties":{"createdAt":{"description":"The time the notification token was created","type":"string"},"id":{"description":"The unique identifier for the notification token","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"token":{"description":"The actual token of the notification token","type":"string"},"updatedAt":{"description":"The time the notification token was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"description":"The user id that this notification token belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"phone":{"type":"string"},"phoneVerified":{"type":"boolean"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"ssoProviders":{"items":{"type":"string"},"type":"array","uniqueItems":false},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"username":{"type":"string"}},"type":"object","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"cognitoId":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"email":{"type":"string"},"emailVerified":{"type":"boolean"},"firstName":{"type":"string"},"id":{"type":"string"},"lastInboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"lastName":{"type":"string"},"lastOutboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"notificationTokens":{"description":"Relationships","items":{"properties":{"createdAt":{"description":"The time the notification token was created","type":"string"},"id":{"description":"The unique identifier for the notification token","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"token":{"description":"The actual token of the notification token","type":"string"},"updatedAt":{"description":"The time the notification token was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"description":"The user id that this notification token belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"phone":{"type":"string"},"phoneVerified":{"type":"boolean"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"ssoProviders":{"items":{"type":"string"},"type":"array","uniqueItems":false},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"username":{"type":"string"}},"type":"object","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"$circularRef":"63e0ef96-4dc9-4c89-b86c-ebe82c3168ef"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"abf6320b-c1ae-479b-b2d0-7b415d5ebd07":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"cognitoId":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"email":{"type":"string"},"emailVerified":{"type":"boolean"},"firstName":{"type":"string"},"id":{"type":"string"},"lastInboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"lastName":{"type":"string"},"lastOutboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"notificationTokens":{"description":"Relationships","items":{"properties":{"createdAt":{"description":"The time the notification token was created","type":"string"},"id":{"description":"The unique identifier for the notification token","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"token":{"description":"The actual token of the notification token","type":"string"},"updatedAt":{"description":"The time the notification token was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"description":"The user id that this notification token belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"phone":{"type":"string"},"phoneVerified":{"type":"boolean"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"ssoProviders":{"items":{"type":"string"},"type":"array","uniqueItems":false},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"username":{"type":"string"}},"type":"object","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"7175c923-903d-44b9-b6ff-065b52a322e0":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"cognitoId":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"email":{"type":"string"},"emailVerified":{"type":"boolean"},"firstName":{"type":"string"},"id":{"type":"string"},"lastInboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"lastName":{"type":"string"},"lastOutboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"oneOf":[{}]},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"notificationTokens":{"description":"Relationships","items":{"properties":{"createdAt":{"description":"The time the notification token was created","type":"string"},"id":{"description":"The unique identifier for the notification token","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"token":{"description":"The actual token of the notification token","type":"string"},"updatedAt":{"description":"The time the notification token was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"description":"The user id that this notification token belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"phone":{"type":"string"},"phoneVerified":{"type":"boolean"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"ssoProviders":{"items":{"type":"string"},"type":"array","uniqueItems":false},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"username":{"type":"string"}},"type":"object","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"a5698016-0e1a-4fee-9a8f-cf3d08bc4767":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"cognitoId":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"email":{"type":"string"},"emailVerified":{"type":"boolean"},"firstName":{"type":"string"},"id":{"type":"string"},"lastInboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"lastName":{"type":"string"},"lastOutboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"notificationTokens":{"description":"Relationships","items":{"properties":{"createdAt":{"description":"The time the notification token was created","type":"string"},"id":{"description":"The unique identifier for the notification token","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"token":{"description":"The actual token of the notification token","type":"string"},"updatedAt":{"description":"The time the notification token was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"description":"The user id that this notification token belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"phone":{"type":"string"},"phoneVerified":{"type":"boolean"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"ssoProviders":{"items":{"type":"string"},"type":"array","uniqueItems":false},"updatedAt":{"type":"string"},"userMemberships":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"username":{"type":"string"}},"type":"object"},"f22a6113-fa9c-499f-8c84-52fa19603838":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"cognitoId":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"email":{"type":"string"},"emailVerified":{"type":"boolean"},"firstName":{"type":"string"},"id":{"type":"string"},"lastInboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"lastName":{"type":"string"},"lastOutboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"notificationTokens":{"description":"Relationships","items":{"properties":{"createdAt":{"description":"The time the notification token was created","type":"string"},"id":{"description":"The unique identifier for the notification token","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"token":{"description":"The actual token of the notification token","type":"string"},"updatedAt":{"description":"The time the notification token was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"description":"The user id that this notification token belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"phone":{"type":"string"},"phoneVerified":{"type":"boolean"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"ssoProviders":{"items":{"type":"string"},"type":"array","uniqueItems":false},"updatedAt":{"type":"string"},"userMemberships":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"username":{"type":"string"}},"type":"object","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"0a885bd8-71c0-4ec1-8858-3f367df611b0":{"properties":{"author":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"cognitoId":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"email":{"type":"string"},"emailVerified":{"type":"boolean"},"firstName":{"type":"string"},"id":{"type":"string"},"lastInboundMessage":{"oneOf":[{}]},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"notificationTokens":{"description":"Relationships","items":{"properties":{"createdAt":{"description":"The time the notification token was created","type":"string"},"id":{"description":"The unique identifier for the notification token","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"token":{"description":"The actual token of the notification token","type":"string"},"updatedAt":{"description":"The time the notification token was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"description":"The user id that this notification token belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"phone":{"type":"string"},"phoneVerified":{"type":"boolean"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"ssoProviders":{"items":{"type":"string"},"type":"array","uniqueItems":false},"updatedAt":{"type":"string"},"userMemberships":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"username":{"type":"string"}},"type":"object","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"cognitoId":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"email":{"type":"string"},"emailVerified":{"type":"boolean"},"firstName":{"type":"string"},"id":{"type":"string"},"lastInboundMessage":{"oneOf":[{}]},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"notificationTokens":{"description":"Relationships","items":{"properties":{"createdAt":{"description":"The time the notification token was created","type":"string"},"id":{"description":"The unique identifier for the notification token","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"token":{"description":"The actual token of the notification token","type":"string"},"updatedAt":{"description":"The time the notification token was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"description":"The user id that this notification token belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"phone":{"type":"string"},"phoneVerified":{"type":"boolean"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"ssoProviders":{"items":{"type":"string"},"type":"array","uniqueItems":false},"updatedAt":{"type":"string"},"userMemberships":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"username":{"type":"string"}},"type":"object","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"cognitoId":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"email":{"type":"string"},"emailVerified":{"type":"boolean"},"firstName":{"type":"string"},"id":{"type":"string"},"lastInboundMessage":{"oneOf":[{}]},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"notificationTokens":{"description":"Relationships","items":{"properties":{"createdAt":{"description":"The time the notification token was created","type":"string"},"id":{"description":"The unique identifier for the notification token","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"token":{"description":"The actual token of the notification token","type":"string"},"updatedAt":{"description":"The time the notification token was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"description":"The user id that this notification token belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"phone":{"type":"string"},"phoneVerified":{"type":"boolean"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"ssoProviders":{"items":{"type":"string"},"type":"array","uniqueItems":false},"updatedAt":{"type":"string"},"userMemberships":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"username":{"type":"string"}},"type":"object","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"cognitoId":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"email":{"type":"string"},"emailVerified":{"type":"boolean"},"firstName":{"type":"string"},"id":{"type":"string"},"lastInboundMessage":{"oneOf":[{}]},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"notificationTokens":{"description":"Relationships","items":{"properties":{"createdAt":{"description":"The time the notification token was created","type":"string"},"id":{"description":"The unique identifier for the notification token","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"token":{"description":"The actual token of the notification token","type":"string"},"updatedAt":{"description":"The time the notification token was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"description":"The user id that this notification token belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"phone":{"type":"string"},"phoneVerified":{"type":"boolean"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"ssoProviders":{"items":{"type":"string"},"type":"array","uniqueItems":false},"updatedAt":{"type":"string"},"userMemberships":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"username":{"type":"string"}},"type":"object","description":"Relationships"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"cognitoId":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"email":{"type":"string"},"emailVerified":{"type":"boolean"},"firstName":{"type":"string"},"id":{"type":"string"},"lastInboundMessage":{"oneOf":[{}]},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"notificationTokens":{"description":"Relationships","items":{"properties":{"createdAt":{"description":"The time the notification token was created","type":"string"},"id":{"description":"The unique identifier for the notification token","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"token":{"description":"The actual token of the notification token","type":"string"},"updatedAt":{"description":"The time the notification token was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"description":"The user id that this notification token belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"phone":{"type":"string"},"phoneVerified":{"type":"boolean"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"ssoProviders":{"items":{"type":"string"},"type":"array","uniqueItems":false},"updatedAt":{"type":"string"},"userMemberships":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"username":{"type":"string"}},"type":"object","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last inbound message posted to the conversation"},"lastMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"$circularRef":"0a885bd8-71c0-4ec1-8858-3f367df611b0","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"755d3a51-01e8-441e-a954-b8fcf2561ce3":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"cognitoId":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"email":{"type":"string"},"emailVerified":{"type":"boolean"},"firstName":{"type":"string"},"id":{"type":"string"},"lastInboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"oneOf":[{}]},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"oneOf":[{}]},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"lastName":{"type":"string"},"lastOutboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"oneOf":[{}]},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"oneOf":[{}]},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"notificationTokens":{"description":"Relationships","items":{"properties":{"createdAt":{"description":"The time the notification token was created","type":"string"},"id":{"description":"The unique identifier for the notification token","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"token":{"description":"The actual token of the notification token","type":"string"},"updatedAt":{"description":"The time the notification token was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"description":"The user id that this notification token belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"phone":{"type":"string"},"phoneVerified":{"type":"boolean"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"ssoProviders":{"items":{"type":"string"},"type":"array","uniqueItems":false},"updatedAt":{"type":"string"},"userMemberships":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"username":{"type":"string"}},"type":"object","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"oneOf":[{}]},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"oneOf":[{}]},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"oneOf":[{}]},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"oneOf":[{}]},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the inbound channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the inbound channel was last updated","type":"string"},"verifiedAt":{"description":"The date and time the inbound channel was verified. (i.e. the contact has\ncompleted a verififation workflow)","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the inbound channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"labels":{"description":"The label ids that the conversation belongs to","items":{"type":"string"},"type":"array","uniqueItems":false},"lastInboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"oneOf":[{}]},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"oneOf":[{}]},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"The last inbound message posted to the conversation"},"lastMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"oneOf":[{}]},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"oneOf":[{}]},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"The last message posted to the conversation"},"lastMessageTime":{"description":"Nullable timestamp of when the last message was sent","type":"string"},"lastOutboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"oneOf":[{}]},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"deliveredAt":{"description":"When the message was delivered to the recipient","type":"string"},"fallbacks":{"description":"A list of tag fallbacks to use if tag data is not found","items":{"properties":{"createdAt":{"description":"The created at timestamp","type":"string"},"dataType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The data entity type where the tag will retrieve real data"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The deleted at timestamp"},"displayName":{"description":"When set, this will be displayed instead of the template in the UI","type":"string"},"fallback":{"description":"The fallback value to use if the tag data is empty or not found","type":"string"},"id":{"description":"The ulid for the tag","type":"string"},"key":{"description":"The dot delimited key that will be used to retrieve the value for the tag","type":"string"},"object":{"description":"The object type of the tag","type":"string"},"template":{"description":"The templated text we search for in the message","type":"string"},"updatedAt":{"description":"The updated at timestamp","type":"string"},"workspaceId":{"description":"The workspace id the tag belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"from":{"description":"The sender of the message (phone number, email, etc)","type":"string"},"group":{"description":"A list of addresses to send the group message to","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"multipartId":{"description":"The provider ID of the multipart message","type":"string"},"multipartNum":{"description":"The number of the message part in a multipart message","type":"integer"},"object":{"description":"The object type","type":"string"},"outbound":{"description":"Indicates if the message is outbound or inbound","type":"boolean"},"priority":{"enum":["normal","high"],"type":"string","x-enum-varnames":["MessagePriorityNormal","MessagePriorityHigh"],"description":"The priority of the message. A higher priority message will be sent before a lower priority message"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"MessageProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","MessageProviderTwilio":"twilio is our own numbers that MessageDesk owns in it's own Twilio account","MessageProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["MessageProviderBandwidth","MessageProviderTwilio","MessageProviderTwilioBYOC","MessageProviderTelgorithm"],"description":"The provider used to send the message"},"providerErr":{"description":"An error string returned by the provider","type":"string"},"providerId":{"description":"The external provider message ID","type":"string"},"providerRef":{"description":"The reference we use to track workspace and message context in send callbacks","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"readAt":{"description":"When the message was read at by the recipient","type":"string"},"relay":{"properties":{"actions":{"description":"The actions to perform when the relay is executed","items":{"properties":{"actionType":{"enum":["assignTeammates","assignToSender","addLabelsToConversation","closeConversation","markConversationRead","markConversationUnread","openConversation","removeLabelsFromConversation","removeAllTeammatesFromConversation","removeTeammatesFromConversation","sendComment","sendMessage","sendWebhook","updateContactProperty"],"type":"string","x-enum-varnames":["RelayActionTypeAssignTeammates","RelayActionTypeAssignToSender","RelayActionTypeAddLabelsToConversation","RelayActionTypeCloseConversation","RelayActionTypeMarkConversationRead","RelayActionTypeMarkConversationUnread","RelayActionTypeOpenConversation","RelayActionTypeRemoveLabelsFromConversation","RelayActionTypeRemoveAllTeammatesFromConversation","RelayActionTypeRemoveTeammatesFromConversation","RelayActionTypeSendComment","RelayActionTypeSendMessage","RelayActionTypeSendWebhook","RelayActionTypeUpdateContactProperty"],"description":"The type of the action to perform","isRequired":true},"data":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The data to pass to the action","isRequired":true},"id":{"description":"The unique ULID identifier of the action","type":"string","isRequired":true},"delay":{"properties":{"delay":{"minimum":1,"type":"integer","isRequired":true},"unit":{"enum":["minute","hour","day","week","month","year"],"type":"string","x-enum-varnames":["RelayActionDelayUnitMinute","RelayActionDelayUnitHour","RelayActionDelayUnitDay","RelayActionDelayUnitWeek","RelayActionDelayUnitMonth","RelayActionDelayUnitYear"],"isRequired":true}},"required":["delay","unit"],"type":"object","description":"The delay in seconds to wait before executing the action"},"eventData":{"description":"Paths into the triggering event data used to populate dynamic action fields","items":{"type":"string"},"type":"array","uniqueItems":false},"order":{"description":"The order of the action in the group","minimum":0,"type":"integer"}},"required":["actionType","data","id"],"type":"object"},"type":"array","uniqueItems":false},"activeHours":{"properties":{"flipLogic":{"type":"boolean"},"friday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"monday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"saturday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"sunday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"thursday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"timezone":{"enum":["America/Los_Angeles","America/Denver","America/Phoenix","America/Chicago","America/New_York","America/Anchorage","Pacific/Honolulu","UTC","America/Puerto_Rico","America/Halifax"],"type":"string","x-enum-comments":{"AtlanticStandardTime":"Canada has 6 timezones and this is 1 hour ahead of EST, canonically known as AtlanticStandardTime","MoutainTimeAZ":"Arizona doesn't follow DST so they have their own timezone"},"x-enum-varnames":["PacificTime","MountainTime","MoutainTimeAZ","CentralTime","EasternTime","AlaskaTime","HawaiiTime","UTC","PuertoRicoTime","AtlanticStandardTime"]},"tuesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"},"wednesday":{"properties":{"endTime":{"description":"The end time of the daily time window","type":"string","isRequired":true},"rangeType":{"enum":["openAllDay","closedAllDay","timeRange"],"type":"string","x-enum-varnames":["RelayDailyTimeRangeTypeOpenAllDay","RelayDailyTimeRangeTypeClosedAllDay","RelayDailyTimeRangeTypeTimeRange"],"description":"Determines if the relay is run all day, closed all day, or a time range.","isRequired":true},"startTime":{"description":"The start time of the daily time window","type":"string","isRequired":true}},"required":["endTime","rangeType","startTime"],"type":"object"}},"type":"object","description":"The day and times the relay is active (nullable). A null value indicates\nthe relay is active at all times."},"color":{"description":"The color of the relay","type":"string"},"conditions":{"description":"The conditions that must be met for the relay to execute","items":{"properties":{"id":{"description":"The unique ULID identifier of the condition","type":"string","isRequired":true},"logicalOperator":{"enum":["AND","OR"],"type":"string","x-enum-varnames":["LogicalOperatorAnd","LogicalOperatorOr"],"description":"Logical operator for combining conditions in the group","isRequired":true},"operator":{"enum":["contains","equals","notEquals","startsWith","endsWith"],"type":"string","x-enum-varnames":["RelayOperatorContains","RelayOperatorEquals","RelayOperatorNotEquals","RelayOperatorStartsWith","RelayOperatorEndsWith"],"description":"The operator to use when checking the field against the value","isRequired":true},"useCase":{"enum":["MessageContainsText","FailureContainsText","CommentContainsText","OutboundChannelEquals","IsAnonymousConversation","IsNewConversation","IsUnassignedConversation","ConversationLabelEquals","ConversationLabelNameEquals","ConversationLabelActionEquals","TeammateAssigned","PropertyEqualsText"],"type":"string","x-enum-varnames":["RelayConditionUseCaseMessageContainsText","RelayConditionUseCaseFailureContainsText","RelayConditionUseCaseCommentContainsText","RelayConditionUseCaseOutboundChannelEquals","RelayConditionUseCaseIsAnonymousConversation","RelayConditionUseCaseIsNewConversation","RelayConditionUseCaseIsUnassignedConversation","RelayConditionUseCaseConversationLabelEquals","RelayConditionUseCaseConversationLabelNameEquals","RelayConditionUseCaseConversationLabelActionEquals","RelayConditionUseCaseTeammateAssigned","RelayConditionUseCasePropertyEqualsText"],"description":"The type of condition to check\nThe use case to use when checking the condition","isRequired":true},"caseSensitive":{"description":"If true, the match value will be checked case sensitively","type":"boolean"},"matchData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"Additional match criteria for use cases that require structured data"},"matchValue":{"description":"The value to check against the field","maxLength":255,"type":"string"},"order":{"description":"The order of the condition in the group","minimum":0,"type":"integer"}},"required":["id","logicalOperator","operator","useCase"],"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time when the relay was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time when the relay was soft deleted"},"description":{"description":"The custom description of the relay","type":"string"},"eventName":{"enum":["AddRemoveOptOutRequest","AdminDatabaseSeed","AuthUserUpdated","BrandCreated","BandwidthOrderWebhookReceived","BrandDeleted","BrandUpdated","BroadcastCreated","BroadcastDeleted","BroadcastMessageSendRequest","BroadcastMessageSent","BroadcastUpdated","CallForwarded","CallReceived","CampaignCreated","CampaignDeleted","CampaignUpdated","ClientDeployed","CommentCreated","CommentDeleted","CommentUpdated","ConsentCreated","ConsentDeleted","ConsentUpdated","ContactCreated","ContactDeleted","ContactUpdated","ContactPropertyCreated","ContactPropertyDeleted","ContactPropertyUpdated","ConversationAllUsersUnassigned","ConversationClosed","ConversationCreated","ConversationDeleted","ConversationLabelApplied","ConversationLabelRemoved","ConversationOpened","ConversationUpdated","ConversationUpdateLabelsAndUsers","ConversationUsersAssigned","EventCreated","EventDeleted","EventUpdated","EventStreamWebhookReceived","ExportCreated","ExportShard","ExportCompleted","FilterCreated","FilterDeleted","FilterUpdated","FlagCreated","FlagDeleted","FlagUpdated","ImportCreated","ImportShard","ImportCompleted","InboundCallWebhookReceived","InboundChannelBlocked","InboundChannelCreated","InboundChannelDeleted","InboundChannelUpdated","InboundComplianceReplyRequest","InboundMessageWebhookReceived","InboundWebhookReceived","InvitationCreated","InvitationDeleted","InvitationUpdated","LabelCreated","LabelDeleted","LabelUpdated","MediaCreated","MediaDeleted","MediaUpdated","MessageBlocked","MessageCreated","MessageDeleted","MessageDelivered","MessageFailed","MessageReceived","MessageReceivedUserNotificationRequest","MessageScheduled","MessageScheduleDeleted","MessageScheduleUpdated","MessageSent","MessageSendRequest","MessageUpdated","MessageDraftCreated","MessageDraftDeleted","MessageDraftUpdated","MessagesExported","MessageTagCreated","MessageTagDeleted","MessageTagUpdated","MessageTemplateCreated","MessageTemplateDeleted","MessageTemplateUpdated","MessageStatusWebhookReceived","MigratePhoneBW","MigrateFormattedPhoneBW","MigrationV1Started","MigrationV1Completed","MigrationV1Download","MigrationV1DownloadComplete","MigrationV1ProcessContacts","MigrationV1ProcessContactRow","MigrationV1ProcessExtensionOptions","MigrationV1ProcessExtensionOptionRow","MigrationV1ProcessMessages","MigrationV1ProcessMessageRow","MigrationV1ProcessMessageTemplates","MigrationV1ProcessMessageTemplateRow","MigrationV1ProcessOptOuts","MigrationV1ProcessOptOutRow","OptOutCreated","OptOutDeleted","OptOutUpdated","OutboundChannelCreated","OutboundChannelDeleted","OutboundChannelUpdated","RelayCreated","RelayDeleted","RelayTriggered","RelayUpdated","ScheduleCreated","ScheduleDeleted","ScheduleUpdated","SearchWorkspaceReindexRequest","SigningSecretCreated","SigningSecretDeleted","StripeWebhookReceived","StripeSubscriptionCanceled","StripeSubscriptionUpdated","SmsNumberCreated","SmsNumberDeleted","SmsNumberUpdated","SubscriptionCreated","SubscriptionDeleted","SubscriptionUpdated","TCRWebhookReceived","TelgorithmPhoneNumberStatusWebhookReceived","TenantCreated","TenantUpdated","TenantDeleted","ThreadCreated","ThreadUpdated","ThreadDeleted","Test","UnreadConversationsCountUpdated","UserConnected","UserDisconnected","UserCreated","UserDeleted","UserHasJoinedTheChannel","UserHasLeftTheChannel","UserLogin","UserStartedTyping","UserStoppedTyping","UserUpdated","UserMembershipCreated","UserMembershipDeleted","UserMembershipUpdated","UserNotificationCreated","UserNotificationDeleted","UserNotificationUpdated","UserRoleCreated","UserRoleDeleted","UserRoleUpdated","UserSettingCreated","UserSettingDeleted","UserSettingUpdated","WebhookSubscriptionCreated","WebhookSubscriptionDeleted","WorkspaceCreated","WorkspaceDeleted","WorkspaceMoved","WorkspaceUpdated","WorkspaceSettingCreated","WorkspaceSettingDeleted","WorkspaceSettingUpdated","*"],"type":"string","x-enum-comments":{"EventNameAddRemoveOptOutRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameAdminDatabaseSeed":"An async request to seed the database with test data","EventNameAuthUserUpdated":"Occurs when the currently authenticated user updates their profile","EventNameBandwidthOrderWebhookReceived":"Bandwidth order update webhook (hosting import / port-in status changes)","EventNameBrandCreated":"Occurs when a brand is created by the brand service","EventNameBrandDeleted":"Occurs when a brand is deleted by the brand service","EventNameBrandUpdated":"Occurs when a brand's status changes (submit/refresh/webhook), for live UI updates","EventNameBroadcastCreated":"Occurs when a broadcast is created by the broadcast service","EventNameBroadcastDeleted":"Occurs when a broadcast is deleted by the broadcast service","EventNameBroadcastMessageSendRequest":"Occurs when doing a broadcast message send","EventNameBroadcastMessageSent":"Occurs when a broadcast message is sent via Messages Service","EventNameBroadcastUpdated":"Occurs when a broadcast is updated by the broadcast service","EventNameCallForwarded":"Occurs when a call is forwarded","EventNameCallReceived":"Occurs when a call is received","EventNameCampaignCreated":"Occurs when a campaign is created by the campaign service","EventNameCampaignDeleted":"Occurs when a campaign is deleted by the campaign service","EventNameCampaignUpdated":"Occurs when a campaign's status changes (submit/refresh/webhook), for live UI updates","EventNameClientDeployed":"Occurs when the client gets deployed","EventNameCommentCreated":"Occurs when a comment is created by the comment service","EventNameCommentDeleted":"Occurs when a comment is deleted by the comment service","EventNameCommentUpdated":"Occurs when a comment is updated by the comment service","EventNameConsentCreated":"Occurs when a consent is created by the consent service","EventNameConsentDeleted":"Occurs when a consent is deleted by the consent service","EventNameConsentUpdated":"Occurs when a consent is updated by the consent service","EventNameContactCreated":"Occurs when a contact is created by the contact service","EventNameContactDeleted":"Occurs when a contact is deleted by the contact service","EventNameContactPropertyCreated":"Occurs when a contact property is created by the contact service","EventNameContactPropertyDeleted":"Occurs when a contact property is deleted by the contact service","EventNameContactPropertyUpdated":"Occurs when a contact property is updated by the contact service","EventNameContactUpdated":"Occurs when a contact is updated by the contact service","EventNameConversationAllUsersUnassigned":"Occurs when all users are unassigned from a Conversation","EventNameConversationClosed":"Occurs when a conversation is closed","EventNameConversationCreated":"Occurs when a conversation is created by the conversation service","EventNameConversationDeleted":"Occurs when a conversation is deleted by the conversation service","EventNameConversationLabelApplied":"Occurs when a conversation has a label applied","EventNameConversationLabelRemoved":"Occurs when a conversation has a label removed","EventNameConversationOpened":"Occurs when a conversation opens","EventNameConversationUpdateLabelsAndUsers":"Occurs when a batch update for Conversations occurs for both users and labels","EventNameConversationUpdated":"Occurs when a conversation is updated by the conversation service","EventNameConversationUsersAssigned":"Occurs when a conversation has users assigned","EventNameEventCreated":"Occurs when an event is created by the event service","EventNameEventDeleted":"Occurs when an event is deleted by the event service","EventNameEventStreamWebhookReceived":"Occurs when a event stream webhook is received by the webhooks service","EventNameEventUpdated":"Occurs when an event is updated by the event service","EventNameExportCompleted":"Occurs when all shards of an export have been processed","EventNameExportCreated":"Occurs when an export job is created by the exports service","EventNameExportShard":"Occurs when the export planner emits a shard for the shard worker to process","EventNameFilterCreated":"Occurs when a filter is created by the contacts service","EventNameFilterDeleted":"Occurs when a filter is deleted by the contacts service","EventNameFilterUpdated":"Occurs when a filter is updated by the contacts service","EventNameFlagCreated":"Occurs when a flag is created by the flag service","EventNameFlagDeleted":"Occurs when a flag is deleted by the flag service","EventNameFlagUpdated":"Occurs when a flag is updated by the flag service","EventNameImportCompleted":"Occurs when all shards of an import have been processed by the imports service","EventNameImportCreated":"Occurs when an import job is created by the imports service (file uploaded, awaiting async processing)","EventNameImportShard":"Occurs when the import planner emits a shard of rows for the shard worker to process","EventNameInboundCallWebhookReceived":"Occurs when an inbound call webhook is received","EventNameInboundChannelBlocked":"Occurs when an inbound channel is blockedAt is set","EventNameInboundChannelCreated":"Occurs when an inbound channel is created by the channel service","EventNameInboundChannelDeleted":"Occurs when an inbound channel is deleted by the channel service","EventNameInboundChannelUpdated":"Occurs when an inbound channel is updated by the channel service","EventNameInboundComplianceReplyRequest":"Occurs on the 'MessageReceived' event, when message service dispatches async post processors","EventNameInboundMessageWebhookReceived":"Occurs when one of our message providers sends us an inbound message webhook","EventNameInboundWebhookReceived":"Occurs when an inbound workspace webhook is received","EventNameInvitationCreated":"Occurs when an invitation is created by the invitation service","EventNameInvitationDeleted":"Occurs when an invitation is deleted by the invitation service","EventNameInvitationUpdated":"Occurs when an invitation is updated by the invitation service","EventNameLabelCreated":"Occurs when a label is created by the label service","EventNameLabelDeleted":"Occurs when a label is deleted by the label service","EventNameLabelUpdated":"Occurs when a label is updated by the label service","EventNameMediaCreated":"Occurs when a media is created by the media service","EventNameMediaDeleted":"Occurs when a media is deleted by the media service","EventNameMediaUpdated":"Occurs when a media is updated by the media service","EventNameMessageBlocked":"Occurs when an inbound message is received from a blocked inbound channel (ie sender)","EventNameMessageCreated":"Occurs when a message is created by the message service, and not queued for sending","EventNameMessageDeleted":"Occurs when a message is deleted by the message service","EventNameMessageDelivered":"Occurs when a message is delivered by the message service","EventNameMessageDraftCreated":"Occurs when a message draft is created by the message service","EventNameMessageDraftDeleted":"Occurs when a message draft is deleted by the message service","EventNameMessageDraftUpdated":"Occurs when a message draft is updated by the message service","EventNameMessageFailed":"Occurs when a message fails to send by the message service","EventNameMessageReceived":"Occurs when an inbound message is received by the message service","EventNameMessageReceivedUserNotificationRequest":"Occurs when user notifications service fans out a MessageReceived alert to one workspace member","EventNameMessageScheduleDeleted":"Occurs when a outbound message schedule is deleted","EventNameMessageScheduleUpdated":"Occurs when a outbound message schedule is updated","EventNameMessageScheduled":"Occurs when a outbound message is scheduled to be sent via a provider by the message service","EventNameMessageSendRequest":"Occurs when a message has been queued for sending by the message service","EventNameMessageSent":"Occurs when a outbound message is sent via a provider by the message service","EventNameMessageStatusWebhookReceived":"Occurs when a message providers status webhook is received by the message service","EventNameMessageTagCreated":"Occurs when a message tag is created by the message tags service","EventNameMessageTagDeleted":"Occurs when a message tag is deleted by the message tags service","EventNameMessageTagUpdated":"Occurs when a message tag is updated by the message tags service","EventNameMessageTemplateCreated":"Occurs when a message template is created by the message service","EventNameMessageTemplateDeleted":"Occurs when a message template is deleted by the message service","EventNameMessageTemplateUpdated":"Occurs when a message template is updated by the message service","EventNameMessageUpdated":"Occurs when a message is updated by the message service","EventNameMessagesExported":"Occurs when a messages export completes","EventNameMigrateFormattedPhoneBW":"Occurs after our MigratePhoneBW event is fired and is just the same event but it now has workspace and tenant context so our numbers service can handle it","EventNameMigratePhoneBW":"Occurs when a phone migration request has been made by v1 for Bandwidth to process","EventNameMigrationV1Completed":"Occurs when a migration v1 process has completed by the migration service","EventNameMigrationV1Download":"Occurs when a migration v1 download is requested by the migration service","EventNameMigrationV1DownloadComplete":"Occurs when a migration v1 download is completed by the migration service","EventNameMigrationV1ProcessContactRow":"Occurs when a migration v1 contact row is being processed by the migration service","EventNameMigrationV1ProcessContacts":"Occurs when a migration v1 contacts csv is getting processed by the migration service // TODO(Isaiah): Make this event more generic so we can use it for other types of data imports like 'EventNameMigrationV1ImportStarted'","EventNameMigrationV1ProcessExtensionOptionRow":"Occurs when a migration v1 extension option row is being processed by the migration service","EventNameMigrationV1ProcessExtensionOptions":"Occurs when a migration v1 extension options csv is getting processed by the migration service","EventNameMigrationV1ProcessMessageRow":"Occurs when a migration v1 message row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplateRow":"Occurs when a migration v1 message template row is being processed by the migration service","EventNameMigrationV1ProcessMessageTemplates":"Occurs when a migration v1 message templates csv is getting processed by the migration service","EventNameMigrationV1ProcessMessages":"Occurs when a migration v1 messages csv is getting processed by the migration service","EventNameMigrationV1ProcessOptOutRow":"Occurs when a migration v1 opt out row is being processed by the migration service","EventNameMigrationV1ProcessOptOuts":"Occurs when a migration v1 opt outs csv is getting processed by the migration service","EventNameMigrationV1Started":"Occurs when a migration v1 process has started by the migration service","EventNameOptOutCreated":"Occurs when an inbound channel opts out of an outbound channel and is created by the opt out service","EventNameOptOutDeleted":"Occurs when an inbound channel opts back into an outbound channel and is deleted by the opt out service","EventNameOptOutUpdated":"Occurs when an inbound channel opt out needs to be updated and is updated by the opt out service","EventNameOutboundChannelCreated":"Occurs when an outbound channel is created by the channel service","EventNameOutboundChannelDeleted":"Occurs when an outbound channel is deleted by the channel service","EventNameOutboundChannelUpdated":"Occurs when an outbound channel is updated by the channel service","EventNameRelayCreated":"Occurs when a relay is created by the relay service","EventNameRelayDeleted":"Occurs when a relay is deleted by the relay service","EventNameRelayTriggered":"Occurs when a relay is triggered by the relay service","EventNameRelayUpdated":"Occurs when a relay is updated by the relay service","EventNameScheduleCreated":"Occurs when a schedule is created by the schedule service","EventNameScheduleDeleted":"Occurs when a schedule is deleted by the schedule service","EventNameScheduleUpdated":"Occurs when a schedule is updated by the schedule service","EventNameSearchWorkspaceReindexRequest":"Occurs when nightly search reindex requests a reindex for one workspace","EventNameSigningSecretCreated":"Occurs when a signing secret is created by the developer service","EventNameSigningSecretDeleted":"Occurs when a signing secret is deleted by the developer service","EventNameSmsNumberCreated":"Occurs when a sms number is created by the numbers service","EventNameSmsNumberDeleted":"Occurs when a sms number is deleted by the numbers service","EventNameSmsNumberUpdated":"Occurs when a sms number is updated by the numbers service","EventNameStripeSubscriptionCanceled":"Occurs when a stripe subscription is canceled by the stripe service","EventNameStripeSubscriptionUpdated":"Occurs when a stripe subscription is updated by the stripe service","EventNameStripeWebhookReceived":"Occurs when a stripe webhook is received by the stripe service","EventNameSubscriptionCreated":"Occurs when a subscription is created by the subscription service","EventNameSubscriptionDeleted":"Occurs when a subscription is deleted by the subscription service","EventNameSubscriptionUpdated":"Occurs when a subscription is updated by the subscription service","EventNameTCRWebhookReceived":"A TCR (Campaign Registry) webhook was received by the webhooks service","EventNameTelgorithmPhoneNumberStatusWebhookReceived":"Telgorithm phone number status webhook (hosting / port-in status changes)","EventNameTenantCreated":"Occurs when a tenant is created by the tenant service","EventNameTenantDeleted":"Occurs when a tenant is deleted by the tenant service","EventNameTenantUpdated":"Occurs when a tenant is updated by the tenant service","EventNameTest":"Occurs when a test event is created by the test service","EventNameThreadCreated":"Occurs when a thread is created by the comment service","EventNameThreadDeleted":"Occurs when a thread is deleted by the comment service","EventNameThreadUpdated":"Occurs when a thread is updated by the comment service","EventNameUnreadConversationsCountUpdated":"Occurs when a conversation status is updated to 'read', or 'unread'.","EventNameUserConnected":"Occurs when a user comes online","EventNameUserCreated":"Occurs when a user is created by the user service","EventNameUserDeleted":"Occurs when a user is deleted by the user service","EventNameUserDisconnected":"Occurs when a user goes offline","EventNameUserHasJoinedTheChannel":"Occurs when a user has joined a websocket channel (typically handled client side)","EventNameUserHasLeftTheChannel":"Occurs when a user has left a websocket channel (typically handled client side)","EventNameUserLogin":"Occurs when a user has passed Cognito auth check during sign-in or refresh","EventNameUserMembershipCreated":"Occurs when a user membership is created by the user memberships service","EventNameUserMembershipDeleted":"Occurs when a user membership is deleted by the user memberships service","EventNameUserMembershipUpdated":"Occurs when a user membership is updated by the user memberships service","EventNameUserNotificationCreated":"Occurs when a user notification is created by the user notification service","EventNameUserNotificationDeleted":"Occurs when a user notification is deleted by the user notification service","EventNameUserNotificationUpdated":"Occurs when a user notification is updated by the user notification service","EventNameUserRoleCreated":"Occurs when a user role is created by the user service","EventNameUserRoleDeleted":"Occurs when a user role is deleted by the user service","EventNameUserRoleUpdated":"Occurs when a user role is updated by the user service","EventNameUserSettingCreated":"Occurs when a user setting is created by the user settings service","EventNameUserSettingDeleted":"Occurs when a user setting is deleted by the user settings service","EventNameUserSettingUpdated":"Occurs when a user setting is updated by the user settings service","EventNameUserStartedTyping":"Occurs when a user is typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserStoppedTyping":"Occurs when a user is no longer typing in a Conversation inside of the inbox. Used for typing indicators.","EventNameUserUpdated":"Occurs when a user is updated by the user service","EventNameWebhookSubscriptionCreated":"Occurs when a webhook subscription is created by the developer service","EventNameWebhookSubscriptionDeleted":"Occurs when a webhook subscription is deleted by the developer service","EventNameWildcard":"A wildcard event used to listen to all events","EventNameWorkspaceCreated":"Occurs when a workspace is created by the workspace service","EventNameWorkspaceDeleted":"Occurs when a workspace is deleted by the workspace service","EventNameWorkspaceMoved":"Occurs when a workspace is moved from one tenant to another by the workspace service","EventNameWorkspaceSettingCreated":"Occurs when a workspace setting is created by the workspace settings service","EventNameWorkspaceSettingDeleted":"Occurs when a workspace setting is deleted by the workspace settings service","EventNameWorkspaceSettingUpdated":"Occurs when a workspace setting is updated by the workspace settings service","EventNameWorkspaceUpdated":"Occurs when a workspace is updated by the workspace service"},"x-enum-varnames":["EventNameAddRemoveOptOutRequest","EventNameAdminDatabaseSeed","EventNameAuthUserUpdated","EventNameBrandCreated","EventNameBandwidthOrderWebhookReceived","EventNameBrandDeleted","EventNameBrandUpdated","EventNameBroadcastCreated","EventNameBroadcastDeleted","EventNameBroadcastMessageSendRequest","EventNameBroadcastMessageSent","EventNameBroadcastUpdated","EventNameCallForwarded","EventNameCallReceived","EventNameCampaignCreated","EventNameCampaignDeleted","EventNameCampaignUpdated","EventNameClientDeployed","EventNameCommentCreated","EventNameCommentDeleted","EventNameCommentUpdated","EventNameConsentCreated","EventNameConsentDeleted","EventNameConsentUpdated","EventNameContactCreated","EventNameContactDeleted","EventNameContactUpdated","EventNameContactPropertyCreated","EventNameContactPropertyDeleted","EventNameContactPropertyUpdated","EventNameConversationAllUsersUnassigned","EventNameConversationClosed","EventNameConversationCreated","EventNameConversationDeleted","EventNameConversationLabelApplied","EventNameConversationLabelRemoved","EventNameConversationOpened","EventNameConversationUpdated","EventNameConversationUpdateLabelsAndUsers","EventNameConversationUsersAssigned","EventNameEventCreated","EventNameEventDeleted","EventNameEventUpdated","EventNameEventStreamWebhookReceived","EventNameExportCreated","EventNameExportShard","EventNameExportCompleted","EventNameFilterCreated","EventNameFilterDeleted","EventNameFilterUpdated","EventNameFlagCreated","EventNameFlagDeleted","EventNameFlagUpdated","EventNameImportCreated","EventNameImportShard","EventNameImportCompleted","EventNameInboundCallWebhookReceived","EventNameInboundChannelBlocked","EventNameInboundChannelCreated","EventNameInboundChannelDeleted","EventNameInboundChannelUpdated","EventNameInboundComplianceReplyRequest","EventNameInboundMessageWebhookReceived","EventNameInboundWebhookReceived","EventNameInvitationCreated","EventNameInvitationDeleted","EventNameInvitationUpdated","EventNameLabelCreated","EventNameLabelDeleted","EventNameLabelUpdated","EventNameMediaCreated","EventNameMediaDeleted","EventNameMediaUpdated","EventNameMessageBlocked","EventNameMessageCreated","EventNameMessageDeleted","EventNameMessageDelivered","EventNameMessageFailed","EventNameMessageReceived","EventNameMessageReceivedUserNotificationRequest","EventNameMessageScheduled","EventNameMessageScheduleDeleted","EventNameMessageScheduleUpdated","EventNameMessageSent","EventNameMessageSendRequest","EventNameMessageUpdated","EventNameMessageDraftCreated","EventNameMessageDraftDeleted","EventNameMessageDraftUpdated","EventNameMessagesExported","EventNameMessageTagCreated","EventNameMessageTagDeleted","EventNameMessageTagUpdated","EventNameMessageTemplateCreated","EventNameMessageTemplateDeleted","EventNameMessageTemplateUpdated","EventNameMessageStatusWebhookReceived","EventNameMigratePhoneBW","EventNameMigrateFormattedPhoneBW","EventNameMigrationV1Started","EventNameMigrationV1Completed","EventNameMigrationV1Download","EventNameMigrationV1DownloadComplete","EventNameMigrationV1ProcessContacts","EventNameMigrationV1ProcessContactRow","EventNameMigrationV1ProcessExtensionOptions","EventNameMigrationV1ProcessExtensionOptionRow","EventNameMigrationV1ProcessMessages","EventNameMigrationV1ProcessMessageRow","EventNameMigrationV1ProcessMessageTemplates","EventNameMigrationV1ProcessMessageTemplateRow","EventNameMigrationV1ProcessOptOuts","EventNameMigrationV1ProcessOptOutRow","EventNameOptOutCreated","EventNameOptOutDeleted","EventNameOptOutUpdated","EventNameOutboundChannelCreated","EventNameOutboundChannelDeleted","EventNameOutboundChannelUpdated","EventNameRelayCreated","EventNameRelayDeleted","EventNameRelayTriggered","EventNameRelayUpdated","EventNameScheduleCreated","EventNameScheduleDeleted","EventNameScheduleUpdated","EventNameSearchWorkspaceReindexRequest","EventNameSigningSecretCreated","EventNameSigningSecretDeleted","EventNameStripeWebhookReceived","EventNameStripeSubscriptionCanceled","EventNameStripeSubscriptionUpdated","EventNameSmsNumberCreated","EventNameSmsNumberDeleted","EventNameSmsNumberUpdated","EventNameSubscriptionCreated","EventNameSubscriptionDeleted","EventNameSubscriptionUpdated","EventNameTCRWebhookReceived","EventNameTelgorithmPhoneNumberStatusWebhookReceived","EventNameTenantCreated","EventNameTenantUpdated","EventNameTenantDeleted","EventNameThreadCreated","EventNameThreadUpdated","EventNameThreadDeleted","EventNameTest","EventNameUnreadConversationsCountUpdated","EventNameUserConnected","EventNameUserDisconnected","EventNameUserCreated","EventNameUserDeleted","EventNameUserHasJoinedTheChannel","EventNameUserHasLeftTheChannel","EventNameUserLogin","EventNameUserStartedTyping","EventNameUserStoppedTyping","EventNameUserUpdated","EventNameUserMembershipCreated","EventNameUserMembershipDeleted","EventNameUserMembershipUpdated","EventNameUserNotificationCreated","EventNameUserNotificationDeleted","EventNameUserNotificationUpdated","EventNameUserRoleCreated","EventNameUserRoleDeleted","EventNameUserRoleUpdated","EventNameUserSettingCreated","EventNameUserSettingDeleted","EventNameUserSettingUpdated","EventNameWebhookSubscriptionCreated","EventNameWebhookSubscriptionDeleted","EventNameWorkspaceCreated","EventNameWorkspaceDeleted","EventNameWorkspaceMoved","EventNameWorkspaceUpdated","EventNameWorkspaceSettingCreated","EventNameWorkspaceSettingDeleted","EventNameWorkspaceSettingUpdated","EventNameWildcard"],"description":"The required event name to trigger the relay"},"icon":{"description":"The icon of the relay","type":"string"},"id":{"description":"The unique ULID identifier of the relay","type":"string"},"lastTriggeredAt":{"description":"The last time the relay was triggered","type":"string"},"name":{"description":"The custom name of the relay","type":"string"},"object":{"description":"The object type of the relay","type":"string"},"order":{"description":"The order the relay is executed in","type":"integer"},"pausedAt":{"description":"The time when the relay was paused/disabled","type":"string"},"relayType":{"enum":["workspace","user"],"type":"string","x-enum-varnames":["RelayTypeWorkspace","RelayTypeUser"],"description":"The type of relay"},"stopOnSuccess":{"description":"If true, the relay will stop processing if any action is successful","type":"boolean"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the relay belongs to","type":"string"},"updatedAt":{"description":"The time when the relay was last updated","type":"string"},"userId":{"description":"The user id required if relay type is 'user'","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the relay belongs to","type":"string"}},"type":"object"},"relayId":{"description":"The relay that sent the message","type":"string"},"segmentCount":{"description":"The number of sms segments in the message","type":"integer"},"smsType":{"enum":["sms","mms"],"type":"string","x-enum-varnames":["SmsTypeSMS","SmsTypeMMS"],"description":"Indicates if the message is an SMS or MMS"},"standardErr":{"description":"The MessageDesk error code used to standarize message provider errors","type":"integer"},"status":{"enum":["blocked","created","delivered","failed","queued","received","sent","unknown"],"type":"string","x-enum-comments":{"MessageStatusBlocked":"An inbound message has been blocked because the sender has been blocked","MessageStatusCreated":"An outbound message has been created, but not sent or queued","MessageStatusDelivered":"An outbound message has been delivered to the recipient","MessageStatusFailed":"An outbound message failed to send","MessageStatusQueued":"An outbound message has been queued for sending","MessageStatusReceived":"An inbound message has been received, and saved to the database.","MessageStatusSent":"An outbound message has been via one of our message providers","MessageStatusUnknown":"Message status is unknown because a provider sent us an unhandled status"},"x-enum-varnames":["MessageStatusBlocked","MessageStatusCreated","MessageStatusDelivered","MessageStatusFailed","MessageStatusQueued","MessageStatusReceived","MessageStatusSent","MessageStatusUnknown"],"description":"The status of the message (created, sent, delivered, failed, etc)"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"conversation":{"oneOf":[{}]},"conversationId":{"description":"The conversation the message belongs to","type":"string"},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"media":{"description":"The media urls attached to the message","items":{"type":"string"},"type":"array","uniqueItems":false},"mentions":{"items":{"type":"string"},"type":"array","uniqueItems":false},"object":{"description":"The object type","type":"string"},"reactions":{"items":{"properties":{"content":{"description":"The emoji used for the reaction","type":"string"},"userIds":{"description":"The list of user ids that reacted","items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"text":{"description":"The message text","type":"string"},"thread":{"$circularRef":"1b138897-7b95-44ed-99eb-22d2985c98d0","description":"Child Thread where Thread->ParentID == Comment->ID"},"threadId":{"description":"The parent Thread that this Comment belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the message was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the message was deleted"},"id":{"description":"The unique identifier of the message","type":"string"},"lastReplyText":{"type":"string"},"object":{"description":"The object type","type":"string"},"parentId":{"type":"string"},"parentType":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"Relationships"},"tenantId":{"description":"The tenant the message belongs to","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"Child Thread where Thread->ParentID == Comment->ID"},"to":{"description":"The recipient of the message (phone number, email, etc)","type":"string"},"updatedAt":{"description":"The time the message was last updated","type":"string"},"userId":{"description":"The user who sent the outbound message. Empty indicates an inbound message which is not associated with a user","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace the message belongs to","type":"string"}},"type":"object","description":"The last outbound message posted to the conversation"},"name":{"description":"The optional name of the conversation","type":"string"},"object":{"description":"The object type","type":"string"},"outboundChannel":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object","description":"Relationships"},"outboundChannelId":{"description":"The id of the outbound communication channel message are sent from","type":"string"},"status":{"enum":["closed","read","unread","replied"],"type":"string","x-enum-varnames":["ConversationStatusClosed","ConversationStatusRead","ConversationStatusUnread","ConversationStatusReplied"],"description":"The status of the conversation"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"description":"The tenant id the conversation belongs to","type":"string"},"updatedAt":{"description":"The time the conversation was last updated","type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"description":"The workspace id the conversation belongs to","type":"string"}},"type":"object"},"1b138897-7b95-44ed-99eb-22d2985c98d0":{"properties":{"comments":{"description":"Children comments where Comment->ThreadID == Thread->ID","items":{"properties":{"author":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"cognitoId":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"email":{"type":"string"},"emailVerified":{"type":"boolean"},"firstName":{"type":"string"},"id":{"type":"string"},"lastInboundMessage":{"properties":{"author":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"billable":{"description":"Indicates if the message is billable.","type":"boolean"},"broadcast":{"properties":{"conversationIds":{"description":"The conversations the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"createdAt":{"description":"The time the broadcast was created","type":"string"},"createdById":{"description":"The user that created the broadcast","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the broadcast was deleted"},"deliveredAt":{"description":"The time the broadcast was finished sending","type":"string"},"excludeConversationIds":{"description":"The conversations the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"excludeGroupIds":{"description":"The group ids the broadcast should ignore. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"groupIds":{"description":"The group ids the broadcast is sent to. This can be empty.","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The unique ulid of the broadcast","type":"string"},"media":{"description":"The list of media we use to assemble the broadcast message","items":{"type":"string"},"type":"array","uniqueItems":false},"name":{"description":"The name of the broadcast","type":"string"},"object":{"description":"The object type","type":"string"},"scheduleId":{"description":"The schedule id the broadcast belongs to","type":"string"},"startedAt":{"description":"The time the broadcast was started","type":"string"},"status":{"enum":["created","sending","scheduled","completed"],"type":"string","x-enum-varnames":["BroadcastStatusCreated","BroadcastStatusSending","BroadcastStatusScheduled","BroadcastStatusCompleted"],"description":"The current status of the broadcast"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The tenant the broadcast belongs to"},"tenantId":{"description":"The tenant the broadcast belongs to","type":"string"},"text":{"description":"The test we use to assemble the broadcast message","type":"string"},"totalDelivered":{"description":"The total number of messages that were delivered","type":"integer"},"totalFailed":{"description":"The total number of messages that failed to send","type":"integer"},"totalOptedOut":{"description":"The total number of messages that were opted out and not sent","type":"integer"},"totalSent":{"description":"The total number of messages sent","type":"integer"},"updatedAt":{"description":"The time the broadcast was last updated","type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object","description":"The workspace the broadcast belongs to"},"workspaceId":{"description":"The workspace the broadcast belongs to","type":"string"}},"type":"object"},"broadcastId":{"description":"The broadcast that sent the message","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication (sms, email, etc)"},"conversation":{"properties":{"assignedUserIds":{"description":"The ids of users who are assigned to the conversation","items":{"type":"string"},"type":"array","uniqueItems":false},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of conversation"},"createdAt":{"description":"The time the conversation was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the conversation was soft deleted"},"id":{"description":"The unique ulid of the conversation","type":"string"},"inboundChannelAddresses":{"description":"Composite key of the Inbound Channel's addresses sorted and hyphenated","type":"string"},"inboundChannels":{"items":{"properties":{"address":{"description":"The phone number, email address, chat ID, etc.","type":"string"},"blockedAt":{"description":"The data and time the inbound channel was blocked","type":"string"},"blockedBy":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"blockedById":{"description":"The id of the user that blocked the inbound channel","type":"string"},"carrier":{"description":"The provider of the inbound channel (e.g. ATT, Verizon, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (e.g. SMS, Email, Chat, etc.)"},"contact":{"properties":{"addresses":{"items":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultBilling":{"type":"boolean"},"defaultShipping":{"type":"boolean"},"id":{"type":"string"},"object":{"type":"string"},"postalCode":{"type":"string"},"postalCodeSuffix":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"avatarUrl":{"type":"string"},"company":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"firstName":{"type":"string"},"flags":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"inboundChannels":{"description":"Relationships","items":{"$circularRef":"f22a6113-fa9c-499f-8c84-52fa19603838"},"type":"array","uniqueItems":false},"lastInboundMessage":{"oneOf":[{}]},"lastInboundMessageTime":{"type":"string"},"lastName":{"type":"string"},"lastOutboundMessage":{"oneOf":[{}]},"lastOutboundMessageTime":{"type":"string"},"object":{"type":"string"},"properties":{"additionalProperties":{"oneOf":[{}]},"type":"object"},"source":{"enum":["chat","client","crm","forms","import","qbo","seed","webhook","zapier"],"type":"string","x-enum-varnames":["ContactSourceChat","ContactSourceClient","ContactSourceCrm","ContactSourceForms","ContactSourceImport","ContactSourceQbo","ContactSourceSeed","ContactSourceWebhook","ContactSourceZapier"]},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"contactId":{"description":"The id of the contact","type":"string"},"conversations":{"items":{"$circularRef":"755d3a51-01e8-441e-a954-b8fcf2561ce3"},"type":"array","uniqueItems":false},"createdAt":{"description":"The date and time the inbound channel was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the inbound channel was soft deleted"},"id":{"description":"The unique identifier for the inbound channel","type":"string"},"isDefault":{"description":"Indicates the default or preferred inbound channel","type":"boolean"},"object":{"description":"The object type","type":"string"},"tenant":{"properties":{"companyAddress":{"type":"string"},"companyDescription":{"type":"string"},"companyEmail":{"type":"string"},"companyLogo":{"type":"string"},"companyName":{"type":"string"},"companyPhone":{"type":"string"},"companyWebsite":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"object":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"id":{"type":"string"},"invitations":{"items":{"properties":{"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"expiredAt":{"type":"string"},"id":{"type":"string"},"object":{"type":"string"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["InvitationStatusActive","InvitationStatusPending","InvitationStatusExpired","InvitationStatusSuspended"]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"type":"string"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"status":{"enum":["active","pending","expired","suspended"],"type":"string","x-enum-varnames":["UserMembershipStatusActive","UserMembershipStatusPending","UserMembershipStatusExpired","UserMembershipStatusSuspended"]},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"user":{"$circularRef":"a5698016-0e1a-4fee-9a8f-cf3d08bc4767","description":"Relationships"},"userId":{"type":"string"},"userRole":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"userRoleId":{"type":"string"},"userSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is enabled, time indicates when the setting was disabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The object type"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"userId":{"description":"The user id that this setting belongs to","type":"string"},"userMembership":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07","description":"Relationships"},"userMembershipId":{"description":"The user membership id that this setting belongs to","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspace":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRoles":{"items":{"properties":{"admin":{"type":"boolean"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"id":{"type":"string"},"managed":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"permissions":{"properties":{"features":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of feature names to authorization roles","type":"object"},"labels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of labels ids to authorization roles","type":"object"},"outboundChannels":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of outbound channels ids to authorization roles","type":"object"},"teammates":{"additionalProperties":{"enum":["owner","viewer","editor","blocked"],"type":"string","x-enum-varnames":["AuthorizationRoleOwner","AuthorizationRoleViewer","AuthorizationRoleEditor","AuthorizationRoleBlocked"]},"description":"A map of user ids to authorization roles","type":"object"}},"type":"object"},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"description":"Relationships","items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"website":{"type":"string"},"workspaceSettings":{"items":{"properties":{"createdAt":{"description":"The time the setting was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The time the setting was soft deleted"},"enabled":{"description":"null indicates the setting is disabled, time indicates when the setting was enabled","type":"string"},"id":{"description":"The unique identifier for the setting","type":"string"},"object":{"description":"The object type","type":"string"},"tenantId":{"description":"The tenant id that this setting belongs to","type":"string"},"title":{"description":"The display name of the setting","type":"string"},"type":{"enum":["BandwidthWebhook","Broadcast","BroadcastMessageRequest","Brand","CallLog","Campaign","Comment","Consent","Contact","ContactProperty","Conversation","ConversationPreferences","Event","Export","ExportShardInput","Filter","Flag","Group","Import","ImportShardInput","InboundCallReceivedWebhook","InboundChannel","InboundWebhookPayload","InboxAutomation","InboxDataPreference","InboxFeatureAccess","InboxNavigation","InboxPreferences","InboxSignature","Label","Map","Media","Message","MessageReceivedUserNotificationRequest","MessagesCreateDto","MessageDraft","MessageTemplate","MigrationV1","MigrationV1ContactRow","MigrationV1ExtensionOptionRow","MigrationV1MessageRow","MigrationV1MessageTemplateRow","MigrationV1OptOutRow","MigrationFailedRows","NewConversationStatus","NotificationToken","Number","OptOut","OutboundChannel","Relay","Schedule","SigningSecret","SmsNumber","StripeEvent","StripeSubscription","Subscription","Tag","TCRWebhook","TelgorithmWebhook","Tenant","Thread","TypingUser","TwilioWebhook","UnreadConversationsReport","User","UserMembership","UserNotification","UserNotificationPreferences","UserRole","UserSession","UserSetting","WebsocketIdentity","Workspace","WorkspaceAutomationSettings","WorkspaceBrand","WorkspaceSetting"],"type":"string","x-enum-varnames":["DataTypeBandwidthWebhook","DataTypeBroadcast","DataTypeBroadcastMessageRequest","DataTypeBrand","DataTypeCallLog","DataTypeCampaign","DataTypeComment","DataTypeConsent","DataTypeContact","DataTypeContactProperty","DataTypeConversation","DataTypeConversationPreferences","DataTypeEvent","DataTypeExport","DataTypeExportShardInput","DataTypeFilter","DataTypeFlag","DataTypeGroup","DataTypeImport","DataTypeImportShardInput","DataTypeInboundCallReceivedWebhook","DataTypeInboundChannel","DataTypeInboundWebhookPayload","DataTypeInboxAutomation","DataTypeInboxDataPreference","DataTypeInboxFeatureAccess","DataTypeInboxNavigation","DataTypeInboxPreferences","DataTypeInboxSignature","DataTypeLabel","DataTypeMap","DataTypeMedia","DataTypeMessage","DataTypeMessageReceivedUserNotificationRequest","DataTypeMessagesCreateDto","DataTypeMessageDraft","DataTypeMessageTemplate","DataTypeMigrationV1","DataTypeMigrationV1ContactRow","DataTypeMigrationV1ExtensionOptionRow","DataTypeMigrationV1MessageRow","DataTypeMigrationV1MessageTemplateRow","DataTypeMigrationV1OptOutRow","DataTypeMigrationFailedRows","DataTypeNewConversationStatus","DataTypeNotificationToken","DataTypeNumber","DataTypeOptOut","DataTypeOutboundChannel","DataTypeRelay","DataTypeSchedule","DataTypeSigningSecret","DataTypeSmsNumber","DataTypeStripeEvent","DataTypeStripeSubscription","DataTypeSubscription","DataTypeTag","DataTypeTCRWebhook","DataTypeTelgorithmWebhook","DataTypeTenant","DataTypeThread","DataTypeTypingUser","DataTypeTwilioWebhook","DataTypeUnreadConversationsReport","DataTypeUser","DataTypeUserMembership","DataTypeUserNotification","DataTypeUserNotificationPreferences","DataTypeUserRole","DataTypeUserSession","DataTypeUserSetting","DataTypeWebsocketIdentity","DataTypeWorkspace","DataTypeWorkspaceAutomationSettings","DataTypeWorkspaceBrand","DataTypeWorkspaceSetting"],"description":"The type used to decode the generic 'Value' field"},"updatedAt":{"description":"The time the setting was last updated","type":"string"},"value":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"The the generic data for the specific setting type"},"workspaceId":{"description":"The workspace id that this setting belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false}},"type":"object"},"workspaceId":{"type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"workspaces":{"items":{"properties":{"address":{"type":"string"},"avatarUrl":{"type":"string"},"color":{"type":"string"},"createdAt":{"type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"outboundChannels":{"description":"Relationships","items":{"properties":{"address":{"description":"The address of the communication channel (phone number, email address, etc.)","type":"string"},"communicationType":{"enum":["chat","comment","short_code","sms","email","voice"],"type":"string","x-enum-varnames":["CommunicationTypeChat","CommunicationTypeComment","CommunicationTypeShortCode","CommunicationTypeSMS","CommunicationTypeEmail","CommunicationTypeVoice"],"description":"The type of communication channel (sms, email, chat, etc.)"},"createdAt":{"description":"The date and time the record was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"The date and time the record was soft deleted"},"description":{"description":"An optional description of the communication channel","type":"string"},"id":{"description":"The ULID of the channel","type":"string"},"name":{"description":"The optional name of the channel","type":"string"},"newMessagesCount":{"description":"The number of conversations with status 'unread'","type":"integer"},"object":{"description":"The object type \"OutboundChannel\"","type":"string"},"smsNumber":{"properties":{"callForwardingNumber":{"description":"CallForwardingNumber is the phone number to forward calls to","type":"string"},"campaignId":{"description":"CampaignID is the id of the campaign that the sms number is associated with, doesn't apply to byoc or canadian only traffic","type":"string"},"createdAt":{"description":"CreatedAt is the time the sms number was created","type":"string"},"deletedAt":{"properties":{"time":{"type":"string"},"valid":{"description":"Valid is true if Time is not NULL","type":"boolean"}},"type":"object","description":"DeletedAt is the time the sms number was deleted"},"id":{"description":"ID is the primary key for the sms number","type":"string"},"metaData":{"additionalProperties":{"oneOf":[{}]},"type":"object","description":"MetaData is the metadata for the sms number, used to store any additional data for the sms number that is provider specific"},"number":{"description":"Number is the phone number of the sms number","type":"string"},"object":{"description":"Object is the type of object, in this case \"SmsNumber\"","type":"string"},"outboundChannel":{"oneOf":[{}]},"outboundChannelId":{"description":"OutboundChannelID is the id of the outbound channel to use for the sms number, is nullable as numbers may not be assigned to an outbound channel","type":"string"},"provider":{"enum":["bandwidth","twilio","twilioByoc","telgorithm"],"type":"string","x-enum-comments":{"NumberProviderTelgorithm":"Telgorithm is our own numbers that MessageDesk owns in it's own Telgorithm account","NumberProviderTwilio":"Twilio is our own numbers that MessageDesk owns in it's own Twilio account","NumberProviderTwilioBYOC":"twilioByoc are numbers owned by a customer which have their own Twilio account that we access via pub/priv key"},"x-enum-varnames":["NumberProviderBandwidth","NumberProviderTwilio","NumberProviderTwilioBYOC","NumberProviderTelgorithm"],"description":"Provider is the provider of the sms number"},"status":{"enum":["assigned","failedHosting","failedPortIn","numberInactive","pendingCampaignAssociation","pendingHosting","pendingPortIn","provisioning","ready"],"type":"string","x-enum-comments":{"NumberStatusAssigned":"indicates the number is assigned and ready to be used","NumberStatusFailedHosting":"indicates the number failed hosting","NumberStatusFailedPortIn":"indicates the number failed port-in","NumberStatusNumberInactive":"indicates the number is inactive, could be intentional or due to snapback","NumberStatusPendingCampaignAssociation":"indicates the number is pending a campaign association","NumberStatusPendingHosting":"indicates the number is pending hosting","NumberStatusPendingPortIn":"indicates the number is pending a port-in","NumberStatusProvisioning":"indicates the number has been ordered, but not completed","NumberStatusReady":"indicates the number is ready to be used (ie is not assigned to a channel)"},"x-enum-varnames":["NumberStatusAssigned","NumberStatusFailedHosting","NumberStatusFailedPortIn","NumberStatusNumberInactive","NumberStatusPendingCampaignAssociation","NumberStatusPendingHosting","NumberStatusPendingPortIn","NumberStatusProvisioning","NumberStatusReady"],"description":"Status is the status of the sms number, used to determine if the sms number is active or not, doesn't apply to byoc"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"TenantID is the id of the tenant that the sms number is associated with, is nullable as numbers may not be assigned to a tenant","type":"string"},"tollFree":{"description":"TollFree is true if the sms number is a toll free number, doesn't apply to byoc","type":"boolean"},"updatedAt":{"description":"UpdatedAt is the time the sms number was updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"WorkspaceID is the id of the workspace that the sms number is associated with, is nullable as numbers may not be assigned to a workspace","type":"string"}},"type":"object"},"tenant":{"$circularRef":"7175c923-903d-44b9-b6ff-065b52a322e0","description":"Relationships"},"tenantId":{"description":"The tenant id the channel belongs to","type":"string"},"updatedAt":{"description":"The date and time the record was last updated","type":"string"},"workspace":{"oneOf":[{}]},"workspaceId":{"description":"The workspace id the channel belongs to","type":"string"}},"type":"object"},"type":"array","uniqueItems":false},"phone":{"type":"string"},"stateOrProvince":{"type":"string"},"stripeCustomerId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"tenant":{"oneOf":[{}]},"tenantId":{"type":"string"},"updatedAt":{"type":"string"},"userMemberships":{"items":{"$circularRef":"abf6320b-c1ae-479b-b2d0-7b415d5ebd07"},"type":"array","uniqueItems":false},"userRol